misc/share/PKG-DESC-FORMAT

   1 # --- T2-COPYRIGHT-BEGIN ---
   2 # t2/misc/share/PKG-DESC-FORMAT
   3 # Copyright (C) 2010 - 2025 The T2 SDE Project
   4 # SPDX-License-Identifier: GPL-2.0
   5 # --- T2-COPYRIGHT-END ---
   6
   7 Documentation of the package description tags format. This tags are used in
   8 the *.desc files. If you want to add additional tags, their names have to start
   9 with 'X-' (like [X-FOOBAR]).
  10
  11 Please use the tags in the same order as they are listed in this file. Add
  12 a blank line wherever a '--' is found here and use the X-* flags after all
  13 the other tags. "./scripts/Create-DescPatch" can help you here.
  14
  15 All tags marked with (*) are required, and should be present in every .desc
  16 file. All tags marked with (1) may only occure once.
  17
  18 ----
  19
  20 [COPY]
  21
  22   The ROCK Linux Copyright text (and maybe additional copyright information
  23   regarding the ROCK Linux package sources).
  24
  25 --
  26
  27 [I] [TITLE] (1) (*)
  28
  29   A short description of the package. Can be given only once.
  30
  31 --
  32
  33 [T] [TEXT] (*)
  34
  35   A detailed package description.
  36
  37 --
  38
  39 [U] [URL]
  40
  41   A URL related to the package.
  42   Format:  [U] http://foo.bar/ Description of foo bar
  43   can be used more than once.
  44
  45 --
  46
  47 [A] [AUTHOR] (*)
  48
  49   Format:  # [A] Clifford Wolf <clifford@clifford.at> {Core Maintainer}
  50   The <e-mail> and the {description} are both optional. Can be user more
  51   than once.
  52
  53 [M] [MAINTAINER] (*)
  54
  55   Same format as [A] but contains the maintainer of the ROCK package.
  56
  57 --
  58
  59 [C] [CATEGORY] (*)
  60
  61   Format:  [C] console/administration x11/administration
  62   A list of possible categories can be found in the file PKG-CATEGORIES.
  63
  64 [F] [FLAG]
  65
  66   Format:  [F] DIETLIBC
  67   A list of possible flags can be found in the file PKG-FLAGS.
  68
  69 [R] [ARCH] [ARCHITECTURE]
  70
  71   Format:  [R] + intel
  72   Format:  [R] - sparc powerpc
  73   Usually a packge is built on all architectures. If you are using [R]
  74   with '+' the package will only be built for the given architectures.
  75   If you use it with '-' it will be built for all except the given
  76   architectures.
  77
  78 [K] [KERN] [KERNEL]
  79
  80   Format:  [K] + linux
  81   Format:  [K] - minix
  82   Usually a packge is built on all kernels. If you are using [K]
  83   with '+' the package will only be built for the given kernels.
  84   If you use it with '-' it will be built for all except the given
  85   kernels.
  86
  87 --
  88
  89 [E] [DEP] [DEPENDENCY]
  90
  91   Format: [E] group compiler
  92   All dependencies to a package in this group (compiler) will get expanded to
  93   dependencies to all packages in this group.
  94
  95 --
  96
  97 [L] [LICENSE] (1) (*)
  98
  99   Format:  [L] GPL
 100   I will add a list of possible values to Documentation/Developers/REGISTER
 101
 102 [S] [STATUS] (1) (*)
 103
 104   Format:  [S] Stable
 105   where 'Stable' also can be 'Gamma' (very close to stable), 'Beta' or
 106   'Alpha' (far away from stable).
 107
 108 [V] [VER] [VERSION] (1) (*)
 109
 110   Package version and revision (example: '[V] 2.3 19991204').
 111
 112 [P] [PRI] [PRIORITY] (1) (*)
 113
 114   Format: [P] X --3-----9 010.066
 115   The first field specifies if the package should be built on default or
 116   not (X=on, O=off). The second and third field specify the stages and
 117   build-order for that package.
 118
 119 --
 120
 121 [CV-URL] (1)
 122
 123   Format: [CV-URL] http://www.research.avayalabs.com/project/libsafe/
 124   The URL used by ./scripts/Check-PkgVersion.
 125
 126
 127 [CV-FLAGS] (1)
 128
 129   Format: [CV-FLAGS] ODD-UNSTABLE NO-PREFIX
 130   The flags used for auto update scanning.
 131
 132 [CV-GROUP] (1)
 133
 134   Format: [CV-GROUP] group-name
 135   The flags used for auto update scanning.
 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