etc/desc_format

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