mirror of the now-defunct rocklinux.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

162 lines
3.9 KiB

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