[Cdd-commits] r657 - cdd/trunk/cdd/doc/en
CDD Subversion Commit
noreply at alioth.debian.org
Thu Apr 3 14:23:49 UTC 2008
Author: tille
Date: Thu Apr 3 14:23:48 2008
New Revision: 657
Modified:
cdd/trunk/cdd/doc/en/06_technology.sgml
cdd/trunk/cdd/doc/en/08_websentinel.sgml
cdd/trunk/cdd/doc/en/A_devel.sgml
Log:
Documentation of more fields in tasks files
Modified: cdd/trunk/cdd/doc/en/06_technology.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/06_technology.sgml (original)
+++ cdd/trunk/cdd/doc/en/06_technology.sgml Thu Apr 3 14:23:48 2008
@@ -15,21 +15,6 @@
<tag>Depends</tag>
<item><p>Use "Depends" for packages that are definitely needed
for all basic stuff of the CDD in question.</p>
- <p>Remark: For
- <package>cdd-dev</package> versions < 0.4 the list of
- packages that should be installed for a certain task was
- declared as "Depends". This is now changed te enable
- installing the meta-package even if a package belongig
- to this task is missing for whatever reason. It also
- allows finally to remove the meta package. The change
- makes even more sense since <prgn>apt-get</prgn>
- considers "Recommends" as default installation targets.
- </p>
- <p>
- The above behaviour is enforced by
- <package>cdd-dev</package> which changes "Depends" that
- are given in the tasks files into "Recommends".
- </p>
</item>
<tag>Recommends</tag>
<item>The packages that are listed as "Recommends" in the
Modified: cdd/trunk/cdd/doc/en/08_websentinel.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/08_websentinel.sgml (original)
+++ cdd/trunk/cdd/doc/en/08_websentinel.sgml Thu Apr 3 14:23:48 2008
@@ -48,6 +48,17 @@
might exist the source of the meta package does not have to
be changed and will work out of the box after rebuilding.
</item>
+ <tag>Ignore</tag>
+ <item>The Ignore key should be the favourite way to use for
+ specifying prospective packages in case the packages should be
+ evaluated once it appears in the Debian package pool. If
+ "Depends", "Recommends" or "Suggests" are used for not yet
+ existing packages they will be turned into the list of Suggests
+ of the meta package and thus might be possible to become
+ installed on a users machine if the user decides to install all
+ suggested packages. If some evaluation should be done first the
+ "Ignore" tag is your friend.
+ </item>
<tag>Homepage</tag>
<item>This is the URL to the software that should be packaged.
</item>
Modified: cdd/trunk/cdd/doc/en/A_devel.sgml
==============================================================================
--- cdd/trunk/cdd/doc/en/A_devel.sgml (original)
+++ cdd/trunk/cdd/doc/en/A_devel.sgml Thu Apr 3 14:23:48 2008
@@ -55,6 +55,97 @@
<heading><tt>debian/control</tt></heading>
<p>
+The <file>debian/control</file> file of a CDD meta package source
+archive is auto generated out of dependencies that are specified in so
+called <file>tasks</file> files. The rationale behind this is to
+enhance flexibility about changes inside the Debian package pool where
+new packages might appear and others might be renamed.
+The <file>tasks</file> just define which dependencies the CDD
+maintainer group wants to be fulfilled and the
+script <prgn>cdd-gen-control</prgn> verifies whether these
+dependencies exist in the specified package pool and create
+the <file>debian/control</file> file according to the available
+packages. This does not only work for the Debian package pool
+containing the distributions stable, testing and unstable. You can
+even build your meta packages against a different package pool of a
+Debian based distribution. This is for instance used to create the
+SkoleLinux meta packages.
+</p>
+<p>
+The syntax of the <file>tasks</file> files which serve as the central
+database for the information in the <file>debian/control</file> file
+is defined by RFC822. Some of the tags were mentioned formerly in
+<ref id="packageslist"> to explain how the <file>tasks</file> files
+can be used to create the web sentinel pages. Now the tags that
+influence the creation of the <file>debian/control</file> file are given.
+</p>
+<p>
+ <taglist>
+ <tag>Depends</tag>
+ <item>Will be turned to "Recommends" in the
+ resulting <file>debian/control</file> file. The
+ rationale behind this is to enable installing the
+ meta-package even if a package belonging to this task is
+ missing for whatever reason. It also allows finally to
+ remove the meta package. This makes even more
+ sense since <prgn>apt-get</prgn> considers "Recommends"
+ as default installation targets.
+ </item>
+ <tag>Recommends</tag>
+ <item>The packages that are listed as "Recommends" in the
+ tasks file should be installed on the machine where the
+ meta package is installed and which are needed to work
+ on a specific task.
+ </item>
+ <tag>Suggests</tag>
+ <!-- [BA] Why would we suggest non-free? Doesn't policy allow a non-free
+ package to specify "Enhances" to avoid this problem?
+ [AT] I have to admit that "Enhances" is new to me. When
+ reading policy I think this field is out of control of
+ the meta-package developer because it has to be included
+ by the package maintainer. I'm not really convinced that
+ this is a good solution - but I would follow the suggestions
+ of others in this issue.
+ -->
+ <item><p>Use "Suggests" for packages of lesser importance that
+ might be possibly useful, or non-free packages.</p>
+ <p>
+ If a package is not available in the package pool of the
+ target distribution when creating
+ the <file>debian/control</file> file inside the meta
+ package source archive any "Depends" or "Recommends" are
+ turned into "Suggests" to enable a flawless installation
+ of the meta package. Packages that are specified with
+ "Suggests" will not be taken over to
+ the <prgn>tasksel</prgn> control file
+ (CDD<file>-tasks.desk</file>,
+ see <ref id="cdd-tasks.desc">) but only to the list of
+ suggested packages of the according meta package.
+ </item>
+ <tag>Ignore</tag>
+ <item>The "Ignore" key can be used as kind of "Soft-Suggests"
+ to put a package on the radar of the CDD. Packages that
+ are tagged with Ignore will not be taken over into the
+ list of dependencies inside
+ the <file>debian/control</file> file of the resulting
+ meta package neither to the CDD<file>-tasks.desk</file>
+ control file for <prgn>tasksel</prgn> but will be taken
+ over onto the installation medium of a CDD in case there
+ is some space left. This key becomes especially
+ important for specifying not yet packaged software that
+ might be packaged in the future (prospective packages).
+ This is explained in detail in the paragraph about the
+ web sentinel (see <ref id="packageslist">).
+ </item>
+ <tag>Avoids</tag>
+ <item>The "Avoids" key specifies existing packages that will
+ be listed in the the <file>debian/control</file> file as
+ "Recommends" or "Suggests" but, should not go to a
+ installation medium (CD, DVD, etc.) that might be
+ produced by the CDD. A reason to avoid a package might
+ be that it belongs to the non-free section.
+ </item>
+ </taglist>
</p>
</sect1>
More information about the Cdd-commits
mailing list