[Cdd-commits] r292 - in cdd/trunk: cdd cdd/debian cdd/examples/debian cdd/examples/install cdd/examples/install/task1 cdd/examples/tasks doc/en
Andreas Tille
debian-custom@lists.debian.org
Tue, 24 Aug 2004 10:10:33 -0600
Author: tille
Date: Tue Aug 24 10:10:32 2004
New Revision: 292
Added:
cdd/trunk/cdd/examples/debian/cdd-task1.install
cdd/trunk/cdd/examples/debian/cdd-task1.manpages
cdd/trunk/cdd/examples/install/
cdd/trunk/cdd/examples/install/README
cdd/trunk/cdd/examples/install/task1/
cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1 (contents, props changed)
cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1.1
Modified:
cdd/trunk/cdd/VERSION
cdd/trunk/cdd/cdd-install-helper.1
cdd/trunk/cdd/debian/changelog
cdd/trunk/cdd/examples/tasks/README
cdd/trunk/cdd/examples/tasks/task1
cdd/trunk/doc/en/A_appendix.sgml
Log:
Adopted docs and examples to new code.
Modified: cdd/trunk/cdd/VERSION
==============================================================================
--- cdd/trunk/cdd/VERSION (original)
+++ cdd/trunk/cdd/VERSION Tue Aug 24 10:10:32 2004
@@ -1 +1 @@
-0.3.9
+0.4
Modified: cdd/trunk/cdd/cdd-install-helper.1
==============================================================================
--- cdd/trunk/cdd/cdd-install-helper.1 (original)
+++ cdd/trunk/cdd/cdd-install-helper.1 Tue Aug 24 10:10:32 2004
@@ -1,58 +1,65 @@
-.TH cdd-install-helper 1 "March 23, 2004" "CDD - Development"
-.SH NAME
-.B cdd-install-helper
+.TH "cdd-install-helper" "1" "March 23, 2004" "CDD - Development" ""
+.SH "NAME"
+.B cdd\-install\-helper
\- install menu and link to helper bin and according manpage
-.SH SYNOPSIS
-.B cdd-install-helper
+.SH "SYNOPSIS"
+.B cdd\-install\-helper
-.SH DESCRIPTION
+.SH "DESCRIPTION"
This script can be used in debian/rules file to install the user menu
files to /etc/cdd/\fI<cdd>\fR/menu/\fI<package>\fR, a link for the
-helper script of every \fI<cdd>\fR-* package and the link to the manpage
+helper script of every \fI<cdd>\fR\-* package and the link to the manpage
for this script.
-.TP
+.TP
.I menu
If a directory
.I menu
-exists in the building directory it checks for files named like meta packages
-(without the "cdd-" name prefix). These files should be valid menu files
-as they are provided for Debian packages in debian/menu. They will be
-copied to
-.I debian/<pkg>/usr/share/cdd/<cdd>/menu/<pkg>
-where tools like
-.B cdd-user(8)
-will expect them.
-
-Furthermore a check will be done whether there are text files named
-.I docs/<pkg_without_cdd-prefix>/<dependency>.txt
-where
-.I <dependency>
-is a package which is listed in the dependencies of the meta-package.
-These text files should provide reasonable information how to use
-this program in text form which can be viewed by a
-.I pager
-which is better than having no menu entry at all. A menu entry will be
-created which call the pager to this text file after checking whether
-this package is really listed in the dependencies.
-.TP
+exists in the building directory it checks subdirectories
+.I menu/<task>
+(named like meta package without the "cdd\-" name
+prefix). This subdirectory might contain three types of files:
+.IP
+.I <dep>.menu
+These files should be valid menu files as they are provided for Debian
+packages in debian/menu. They will be copied to
+.I usr/share/cdd/<cdd>/menu/<dep>
+and can be used to override the menu items which are provided by the
+maintainer of the package
+.I <dep>
+in case the meta package author likes to change the normal menu item
+for the user menus.
+.IP
+.I <dep>.html
+These files might contain documentation of the dependency in HTML
+format if it makes no sense to provide a menu entry to actually call a
+program in the package.
+.IP
+.I <dep>.txt
+These files might contain documentation of the dependency in text
+format if it makes no sense to provide a menu entry to actually call a
+program in the package.
+
+The rationale of the latter both types is to enable a menu entry in
+the user menus for
+.B every
+call a certain program via the menu. These files should provide
+reasonable information how to use this program in text form. This is
+better than having no menu entry at all because the target user might
+use the menu as the first interface of information of his system.
+.TP
.I common
If there exists a file
.I common/common
-and has a size greater than 0 a <cdd>-common package is builded. The
+and has a size greater than 0 a <cdd>\-common package is builded. The
file
.I common/control
was just used to build the appropriate
.I debian/control
file using the
-.B cdd-gen-control(1)
+.B cdd\-gen\-control(1)
tool.
-.TP
-.I docs
-The files which reside in the optional directory
-.I docs/<pkg_without_cdd-prefix>/
-will be copied to the apropriate doc directory of the meta-package.
-.TP
+.TP
.I conf
If there exists a file
.I common/conf
@@ -62,12 +69,40 @@
.I /etc/cdd/cdd.conf
or add further variables. Because it is sourced from shell it has to
follow shell syntax.
+.TP
+.I install
+Here the extra files which might be needed in a meta package (like scripts,
+manpages, etc.) should be copied in a directory named
+.I install/<pkg_without_cdd\-prefix>/
+and the files should be moved into place by using
+.I debian/<pkg>.install
+or
+.I debian/<pkg>.manpages
+etc.
+
+Moreover it is possible to provide extra
+.I debian/<pkg>.config
+and
+.I debian/<pkg>.templates
+files for each meta package if additional
+.I debconf
+configuration is needed. For the translations of the
+.I debconf
+questions some extra caution is required. Because
+.B cdd\-install\-helper
+uses general templates to provide translations for some general questions
+the directory
+.I debian/po
+is overriden in the package building process. To enable translations
+of the extra templates these should be stored in a directory named
+.I debian/po.stub
+and the contents of the files in this directory is appended to the
+apropriate files.
-
-.SH EXAMPLES
+.SH "EXAMPLES"
For the usage of this tool just have a look at the
-.B debian-med
+.B debian\-med
source package.
-.SH AUTHOR
+.SH "AUTHOR"
Andreas Tille <tille@debian.org>.
Modified: cdd/trunk/cdd/debian/changelog
==============================================================================
--- cdd/trunk/cdd/debian/changelog (original)
+++ cdd/trunk/cdd/debian/changelog Tue Aug 24 10:10:32 2004
@@ -1,3 +1,10 @@
+cdd (0.4) UNRELEASED; urgency=low
+
+ * Andreas Tille
+ - Fixed some man pages and examples
+
+ -- Andreas Tille <tille@debian.org> Sat, 21 Aug 2004 09:06:13 +0200
+
cdd (0.3.9) experimental; urgency=low
* Otavio Salvador
Added: cdd/trunk/cdd/examples/debian/cdd-task1.install
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/debian/cdd-task1.install Tue Aug 24 10:10:32 2004
@@ -0,0 +1,3 @@
+### this file is optional and only needed if the install directory is needed
+install/task1/extra-script-which-is-needed-in-task1 usr/bin
+
Added: cdd/trunk/cdd/examples/debian/cdd-task1.manpages
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/debian/cdd-task1.manpages Tue Aug 24 10:10:32 2004
@@ -0,0 +1,3 @@
+### this file is optional and only needed if the install directory is needed
+install/task1/extra-script-which-is-needed-in-task1.1
+
Added: cdd/trunk/cdd/examples/install/README
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/install/README Tue Aug 24 10:10:32 2004
@@ -0,0 +1,9 @@
+If some extra files like scripts of manpages are needed in the meta packages
+the should be placed into apropriate subdirectories of this directory.
+While there is no certain procedure in the cdd-dev tools to handle files
+in this directory it might be a good idea to settle down with some
+default place for those extra files. To move them right into place
+the files debian/<pkg>.install, debian/<pkg>.manpages etc. should
+be used.
+
+See for instance Debian-Med packages.
Added: cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1 Tue Aug 24 10:10:32 2004
@@ -0,0 +1,2 @@
+#!/bin/sh
+echo "Do something useful for task1."
Added: cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1.1
==============================================================================
--- (empty file)
+++ cdd/trunk/cdd/examples/install/task1/extra-script-which-is-needed-in-task1.1 Tue Aug 24 10:10:32 2004
@@ -0,0 +1,15 @@
+.TH extra-script-which-is-needed-in-task1 1 "<date>" "#CDD#"
+.SH NAME
+.B extra-script-which-is-needed-in-task1
+\- some useful script for task1
+
+.SH SYNOPSIS
+.B extra-script-which-is-needed-in-task1
+
+.SH DESCRIPTION
+The task makes no sense without this script - or at least this script
+provides extra functionality which is not in any of the single
+dependencies.
+
+.SH AUTHOR
+Meta Package Autor <mpa@debian.org>.
Modified: cdd/trunk/cdd/examples/tasks/README
==============================================================================
--- cdd/trunk/cdd/examples/tasks/README (original)
+++ cdd/trunk/cdd/examples/tasks/README Tue Aug 24 10:10:32 2004
@@ -1,4 +1,4 @@
This directory is mandatory. Each file had to follow a certain syntax
-to build a valid control file entry for the mata package to build.
+to build a valid control file entry for the meta package to build.
-For extensive example see Debian-Edu.
+For an extensive and working example see Debian-Med packages >= 0.8.9 .
Modified: cdd/trunk/cdd/examples/tasks/task1
==============================================================================
--- cdd/trunk/cdd/examples/tasks/task1 (original)
+++ cdd/trunk/cdd/examples/tasks/task1 Tue Aug 24 10:10:32 2004
@@ -1,4 +1,4 @@
-Architecture: all
+Task: task1
Description: Debian-_CDD_ task1 packages
This meta package will install Debian packages for use in
task1 of Debian-_CDD_.
Modified: cdd/trunk/doc/en/A_appendix.sgml
==============================================================================
--- cdd/trunk/doc/en/A_appendix.sgml (original)
+++ cdd/trunk/doc/en/A_appendix.sgml Tue Aug 24 10:10:32 2004
@@ -34,8 +34,7 @@
<taglist>
<tag>NAME</tag>
<item>
- <prgn>cdd-gen-control</prgn> - install menu and link to helper bin
- and according manpage
+ <prgn>cdd-gen-control</prgn> - generate debian/control file from tasks directory
</item>
<tag>SYNOPSIS</tag>
<item>
@@ -94,7 +93,11 @@
as for <tt>testing</tt> or <tt>unstable</tt>, where new packages
normally go.
</p>
-
+<p>
+For an example of valid <file>tasks</file> files see the
+<file>/usr/share/doc/cdd-dev/examples/tasks</file> or the source
+package of <package>debian-med (>=0.8.9)</package>.
+</p>
</sect1>
<sect1 id="cdd-install-helper">
@@ -125,23 +128,42 @@
<item>
<p>
If a directory <file>menu</file> exists in the building directory
- it checks for files named like meta packages (without the
- <var><cdd>-</var> name prefix). These files should be valid menu
- files as they are provided for Debian packages in
- <file>debian/menu</file>. They will be copied to
- <file>debian/</file><var><pkg></var><file>/usr/share/cdd/</file><var><cdd></var><file>/menu/</file><var><pkg></var>
- where tools like <manref name="cdd-update-menus" section="8">
- will expect them.
- </p><p>
- A check will be performed whether there are text files named
- <file>docs/</file><var><pkg_without_cdd-prefix></var><file>/</file><var><dependency></var><file>.txt</file>
- where <var><dependency></var> is a package that is listed in the
- dependencies of the meta-package. These files should provide
- reasonable information how to use this program in text form that
- can be viewed by a <prgn>pager</prgn>, which is better than having
- no menu entry at all. A menu entry will be created that calls the
- <prgn>pager</prgn> to view this text file after checking whether this
- package is really listed in the dependencies.
+ it checks subdirectories <file>menu/<var><task></var></file>
+ (named like meta package without the <var>cdd</var>- name prefix).
+ This subdirectory might contain three types of files:
+ <taglist>
+ <tag><file><var><dep></var>.menu</file></tag>
+ <item>These files should be valid menu files as they are
+ provided for Debian packages in
+ <file>debian/menu</file>. They will be copied to
+ <file>usr/share/cdd/<var><cdd></var>/menu/<var><dep></var></file>
+ and can be used to override the menu items which are provided
+ by the maintainer of the package
+ <package><var><dep></var></package> in case the meta
+ package author likes to change the normal menu item for the
+ user menus.
+ </item>
+ <tag><file><var><dep></var>.html</file></tag>
+ <item>These files might contain documentation of the
+ dependency in HTML format if it makes no sense to
+ provide a menu entry to actually call a program in the
+ package.
+ </item>
+ <tag><file><var><dep></var>.txt</file></tag>
+ <item>These files might contain documentation of the
+ dependency in text format if it makes no sense to
+ provide a menu entry to actually call a program in the
+ package.
+ </item>
+ </taglist>
+
+ The rationale of the latter both types is to enable a menu entry
+ in the user menus for <strong>every</strong> call a certain
+ program via the menu. These files should provide reasonable
+ information how to use this program in text form. This is better
+ than having no menu entry at all because the target user might
+ use the menu as the first interface of information of his
+ system.
</p>
</item>
<tag><package>common</package></tag>
@@ -152,12 +174,6 @@
appropriate <file>debian/control</file> file using the
<manref name="cdd-gen-control" section="1"> tool.
</item>
- <tag><file>docs</file></tag>
- <item>
- The files that reside in the optional directory
- <file>docs/</file><var><pkg_without_cdd-prefix></var><file>/</file>
- will be copied to the appropriate doc directory of the meta-package.
- </item>
<tag><file>conf</file></tag>
<item>
If there exists a file <file>common/conf</file> and has a size
@@ -168,6 +184,17 @@
<file>/etc/cdd/cdd.conf</file> or add further variables. Because
it is sourced from shell, it has to follow shell syntax.
</item>
+
+ <tag><file>install</file></tag>
+ <item>
+ Here the extra files which might be needed in a meta package
+ (like scripts, manpages, etc.) should be copied in a directory
+ named
+ <file>install/</file><var><pkg_without_cdd-prefix></var><file>/</file>
+ and the files should be moved into place by using
+ <file>debian/<var><pkg></var>.install</file> or
+ <file>debian/<var><pkg></var>.manpages</file> etc.
+ </item>
</taglist>
</p>
</item>