Desc file syntax

From RockWiki

Jump to: navigation, search

Package Description Files - .desc files - consist of lines containing a tag and its corresponding value for the package being described. The tag is surrounded by square brackets, the syntax of the value varies from tag to tag.

Please use the tags in the same order as they are listed here. Add a blank line wherever a dividing horizontal line is found here and use the X-* flags after all the other tags. scripts/CreateDescPatch can help you here.

All tags marked with (*) are required and should be present in every .desc file.

[COPY]
The ROCK Linux Copyright text (and maybe additional copyright information regarding the ROCK Linux package sources).
[I] [TITLE] (*)
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 used 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
Allowed categories can be found in the List of categories.
[F] [FLAG]
Format: [F] DIETLIBC
Allowed flags can be found in the List of flags.
[R] [ARCH] [ARCHITECTURE]
Format: 
[R] + x86
[R] - sparc powerpc
Usually a package 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.
[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.
Format
[E] add xfree86
Add xfree86 to the auto-generated list of dependencies for this package.
Format
{{{ [E] del auctex }}}
Delete auctex from the auto-generated list of dependencies for this package.
[L] [LICENSE] (*)
Format: [L] GPL
For allowed values see List of licenses
[S] [STATUS] (*)
Format: [S] Stable
Here Stable also can be Gamma (very close to stable), Beta or Alpha (far away from stable).
[V] [VER] [VERSION] (*)
Package version and revision: [V] 2.3 2
This means that the software itself has the version 2.3 and the ROCK package has been revised two times.
[P] [PRI] [PRIORITY] (*)
Format: [P] X [0-][1X?-][2-][3-][4-][5-][6-][7-][8-]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 respectively.
If the character for stage 1 is a ? (question mark), then it is not know if the package will cleanly cross compile. If it has an X (capital X), the package is known to cross compile and configured to be cross-compiled (but not built in stage 1 in a normal build). If it has a 1 (number one) it will always be built in stage 1.
[CV-URL]
Format: [CV-URL] http://www.research.avayalabs.com/project/libsafe/
The !URL used by CheckPkgVersion.
[CV-PAT]
Format: [CV-PAT] ^libsafe-[0-9]
The search pattern for scripts/CheckPkgVersion.
[CV-DEL]
Format: [CV-DEL] \.(tgz|tar.gz)$
The delete pattern for scripts/CheckPkgVersion. 
This entry is or will soon be deprecated!
Do not rely on its information and ask for more recent information on the Mailing Lists
[O] [CONF]
Format: [O] srcdir="$pkg-src-$ver"
The given text will be evaluated as if it would be at the top of the ConfFile.
[D] [DOWN] [DOWNLOAD]
Download a file: [D] cksum foo.tar.bz2 http://the-size.org/
The cksum can be initially 0.
The following downloads are supported:
The download path can be followed by NOAUTO which indicates that (for licensing issues, for example) the file can or may not be downloaded using the ROCK framework. A message will be printed with the URL where to download that package.
The download path can also be followed by NODIST which indicates that the sourcefile will not be mirrored to the ROCK mirrors, but must always be downloaded from the original download location. Can be paired with NOAUTO.
[SRC] [SOURCEPACKAGE]
Format: [SRC] tarball1 tarball2
This will enable the function 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.
[CD] [CHECKDEPS]
This flag is used to tell scripts/CheckDeps2 and scripts/CopyCache how to handle split packages.
Retrieved from "http://www.rocklinux.org/wiki/Desc_file_syntax"
Personal tools