# --- T2-COPYRIGHT-NOTE-BEGIN ---
# T2 SDE: misc/share/PKG-DESC-FORMAT
# Copyright (C) 2010 - 2024 The T2 SDE Project
# 
# This Copyright note is generated by scripts/Create-CopyPatch,
# more information can be found in the files COPYING and README.
# 
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2.
# --- T2-COPYRIGHT-NOTE-END ---

Documentation of the package description tags format. This tags are used in
the *.desc files. If you want to add additional tags, their names have to start
with 'X-' (like [X-FOOBAR]).

Please use the tags in the same order as they are listed in this file. Add
a blank line wherever a '--' is found here and use the X-* flags after all
the other tags. "./scripts/Create-DescPatch" can help you here.

All tags marked with (*) are required, and should be present in every .desc
file. All tags marked with (1) may only occure once.

----

[COPY]

  The ROCK Linux Copyright text (and maybe additional copyright information
  regarding the ROCK Linux package sources).

--

[I] [TITLE] (1) (*)

  A short description of the package. Can be given only once.

--

[T] [TEXT] (*)

  A detailed package description.

--

[U] [URL]

  A URL related to the package.
  Format:  [U] http://foo.bar/ Description of foo bar
  can be used more than once.

--

[A] [AUTHOR] (*)

  Format:  # [A] Clifford Wolf <clifford@clifford.at> {Core Maintainer}
  The <e-mail> and the {description} are both optional. Can be user more
  than once.

[M] [MAINTAINER] (*)

  Same format as [A] but contains the maintainer of the ROCK package.

--

[C] [CATEGORY] (*)

  Format:  [C] console/administration x11/administration
  A list of possible categories can be found in the file PKG-CATEGORIES.

[F] [FLAG]

  Format:  [F] DIETLIBC
  A list of possible flags can be found in the file PKG-FLAGS.

[R] [ARCH] [ARCHITECTURE]

  Format:  [R] + intel
  Format:  [R] - sparc powerpc
  Usually a packge is built on all architectures. If you are using [R]
  with '+' the package will only be built for the given architectures.
  If you use it with '-' it will be built for all except the given
  architectures.

[K] [KERN] [KERNEL]

  Format:  [K] + linux
  Format:  [K] - minix
  Usually a packge is built on all kernels. If you are using [K]
  with '+' the package will only be built for the given kernels.
  If you use it with '-' it will be built for all except the given
  kernels.

--

[E] [DEP] [DEPENDENCY]

  Format: [E] group compiler
  All dependencies to a package in this group (compiler) will get expanded to
  dependencies to all packages in this group.

--

[L] [LICENSE] (1) (*)

  Format:  [L] GPL
  I will add a list of possible values to Documentation/Developers/REGISTER

[S] [STATUS] (1) (*)

  Format:  [S] Stable
  where 'Stable' also can be 'Gamma' (very close to stable), 'Beta' or
  'Alpha' (far away from stable).

[V] [VER] [VERSION] (1) (*)

  Package version and revision (example: '[V] 2.3 19991204').

[P] [PRI] [PRIORITY] (1) (*)

  Format: [P] X --3-----9 010.066
  The first field specifies if the package should be built on default or
  not (X=on, O=off). The second and third field specify the stages and
  build-order for that package.

--

[CV-URL] (1)

  Format: [CV-URL] http://www.research.avayalabs.com/project/libsafe/
  The URL used by ./scripts/Check-PkgVersion.


[CV-FLAGS] (1)

  Format: [CV-FLAGS] ODD-UNSTABLE NO-PREFIX
  The flags used by ./scripts/Check-PkgVersion.


[CV-PAT]

  Format: [CV-PAT] ^libsafe-[0-9]
  The search pattern for ./scripts/Check-PkgVersion.

[CV-DEL]

  Format: [CV-DEL] \.(tgz|tar.gz)$
  The delete pattern for ./scripts/Check-PkgVersion.

--

[O] [CONF]

  Format: [O] srcdir="$pkg-src-$ver"
  The given text will be evaluated as if it would be at the top of the
  package *.conf file.

--

[D] [DOWN] [DOWNLOAD]

  Download a file. (example: '[D] cksum foo.tar.bz2 http://the-size.org/')
  The cksum can be initially 0.

--

[SRC] [SOURCEPACKAGE] (1)

  Format: [SRC] tarball1 tarball2
  This will enable build_this_package to build the content of more than
  one tarball.
  NOTE: do not put the extension of the tarballs (e.g. tar.gz) into this 
    tag, as it will be autodetected.
  NOTE2: a pattern to match the needed tarball should be enough.
    (example:
    > [D] cksum mypkg-version1.tar.gz http://some.url.tld
    > [D] cksum mypkg-gfx-version2.tbz2 http://some.url.tld
    > [D] cksum mypkg-data-version3.tar.bz2 http://some.url.tld
    > [SRC] mypkg-version1 gfx
    This would run the whole build cycle with mypkg-version1.tar.bz2 and 
    mypkg-gfx-version2.tbz2 but not with mypkg-data-version3.tar.bz2.