misc/share/PKG-DESC-FORMAT

   1 # --- T2-COPYRIGHT-NOTE-BEGIN ---
   2 # T2 SDE: misc/share/PKG-DESC-FORMAT
   3 # Copyright (C) 2010 - 2024 The T2 SDE Project
   4 #
   5 # This Copyright note is generated by scripts/Create-CopyPatch,
   6 # more information can be found in the files COPYING and README.
   7 #
   8 # This program is free software; you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License version 2.
  10 # --- T2-COPYRIGHT-NOTE-END ---
  11
  12 Documentation of the package description tags format. This tags are used in
  13 the *.desc files. If you want to add additional tags, their names have to start
  14 with 'X-' (like [X-FOOBAR]).
  15
  16 Please use the tags in the same order as they are listed in this file. Add
  17 a blank line wherever a '--' is found here and use the X-* flags after all
  18 the other tags. "./scripts/Create-DescPatch" can help you here.
  19
  20 All tags marked with (*) are required, and should be present in every .desc
  21 file. All tags marked with (1) may only occure once.
  22
  23 ----
  24
  25 [COPY]
  26
  27   The ROCK Linux Copyright text (and maybe additional copyright information
  28   regarding the ROCK Linux package sources).
  29
  30 --
  31
  32 [I] [TITLE] (1) (*)
  33
  34   A short description of the package. Can be given only once.
  35
  36 --
  37
  38 [T] [TEXT] (*)
  39
  40   A detailed package description.
  41
  42 --
  43
  44 [U] [URL]
  45
  46   A URL related to the package.
  47   Format:  [U] http://foo.bar/ Description of foo bar
  48   can be used more than once.
  49
  50 --
  51
  52 [A] [AUTHOR] (*)
  53
  54   Format:  # [A] Clifford Wolf <clifford@clifford.at> {Core Maintainer}
  55   The <e-mail> and the {description} are both optional. Can be user more
  56   than once.
  57
  58 [M] [MAINTAINER] (*)
  59
  60   Same format as [A] but contains the maintainer of the ROCK package.
  61
  62 --
  63
  64 [C] [CATEGORY] (*)
  65
  66   Format:  [C] console/administration x11/administration
  67   A list of possible categories can be found in the file PKG-CATEGORIES.
  68
  69 [F] [FLAG]
  70
  71   Format:  [F] DIETLIBC
  72   A list of possible flags can be found in the file PKG-FLAGS.
  73
  74 [R] [ARCH] [ARCHITECTURE]
  75
  76   Format:  [R] + intel
  77   Format:  [R] - sparc powerpc
  78   Usually a packge is built on all architectures. If you are using [R]
  79   with '+' the package will only be built for the given architectures.
  80   If you use it with '-' it will be built for all except the given
  81   architectures.
  82
  83 [K] [KERN] [KERNEL]
  84
  85   Format:  [K] + linux
  86   Format:  [K] - minix
  87   Usually a packge is built on all kernels. If you are using [K]
  88   with '+' the package will only be built for the given kernels.
  89   If you use it with '-' it will be built for all except the given
  90   kernels.
  91
  92 --
  93
  94 [E] [DEP] [DEPENDENCY]
  95
  96   Format: [E] group compiler
  97   All dependencies to a package in this group (compiler) will get expanded to
  98   dependencies to all packages in this group.
  99
 100 --
 101
 102 [L] [LICENSE] (1) (*)
 103
 104   Format:  [L] GPL
 105   I will add a list of possible values to Documentation/Developers/REGISTER
 106
 107 [S] [STATUS] (1) (*)
 108
 109   Format:  [S] Stable
 110   where 'Stable' also can be 'Gamma' (very close to stable), 'Beta' or
 111   'Alpha' (far away from stable).
 112
 113 [V] [VER] [VERSION] (1) (*)
 114
 115   Package version and revision (example: '[V] 2.3 19991204').
 116
 117 [P] [PRI] [PRIORITY] (1) (*)
 118
 119   Format: [P] X --3-----9 010.066
 120   The first field specifies if the package should be built on default or
 121   not (X=on, O=off). The second and third field specify the stages and
 122   build-order for that package.
 123
 124 --
 125
 126 [CV-URL] (1)
 127
 128   Format: [CV-URL] http://www.research.avayalabs.com/project/libsafe/
 129   The URL used by ./scripts/Check-PkgVersion.
 130
 131
 132 [CV-FLAGS] (1)
 133
 134   Format: [CV-FLAGS] ODD-UNSTABLE NO-PREFIX
 135   The flags used by ./scripts/Check-PkgVersion.
 136
 137
 138 [CV-PAT]
 139
 140   Format: [CV-PAT] ^libsafe-[0-9]
 141   The search pattern for ./scripts/Check-PkgVersion.
 142
 143 [CV-DEL]
 144
 145   Format: [CV-DEL] \.(tgz|tar.gz)$
 146   The delete pattern for ./scripts/Check-PkgVersion.
 147
 148 --
 149
 150 [O] [CONF]
 151
 152   Format: [O] srcdir="$pkg-src-$ver"
 153   The given text will be evaluated as if it would be at the top of the
 154   package *.conf file.
 155
 156 --
 157
 158 [D] [DOWN] [DOWNLOAD]
 159
 160   Download a file. (example: '[D] cksum foo.tar.bz2 http://the-size.org/')
 161   The cksum can be initially 0.
 162
 163 --
 164
 165 [SRC] [SOURCEPACKAGE] (1)
 166
 167   Format: [SRC] tarball1 tarball2
 168   This will enable build_this_package to build the content of more than
 169   one tarball.
 170   NOTE: do not put the extension of the tarballs (e.g. tar.gz) into this
 171     tag, as it will be autodetected.
 172   NOTE2: a pattern to match the needed tarball should be enough.
 173     (example:
 174     > [D] cksum mypkg-version1.tar.gz http://some.url.tld
 175     > [D] cksum mypkg-gfx-version2.tbz2 http://some.url.tld
 176     > [D] cksum mypkg-data-version3.tar.bz2 http://some.url.tld
 177     > [SRC] mypkg-version1 gfx
 178     This would run the whole build cycle with mypkg-version1.tar.bz2 and
 179     mypkg-gfx-version2.tbz2 but not with mypkg-data-version3.tar.bz2.
 180