Re-applied comments from SGML source to the DocBook files.

[developers-reference.git] / best-pkging-practices.dbk

diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk
index f1130c201501d35ba885d879ae58665001d8cb50..63b7f87c44284a764154b18c8d440ce5e4c2e8f6 100644 (file)
--- a/best-pkging-practices.dbk
+++ b/best-pkging-practices.dbk
@@ -142,6 +142,8 @@ the same software but with different configuration options.  The <systemitem
 role="package">vim</systemitem> source package is an example of how to manage
 this using an hand-crafted <filename>debian/rules</filename> file.
 </para>
+<!-- FIXME: Find a good debhelper example with multiple configure/make
+     cycles -->
 </section>
 
 </section>
@@ -318,6 +320,10 @@ implementation?  more features?  different features?  Why should I choose this
 package.
 </para>
 </listitem>
+<!-- FIXME: what's this?
+(the second questions is about the class of packages, and
+this about this particular package, if you have information related to both).
+-->
 </itemizedlist>
 </section>
 
@@ -601,6 +607,17 @@ NEWS.Debian file in your package.  No news is good news!
 
 </section>
 
+<!--
+<section id="pkg-mgmt-cvs">
+<title>Managing a package with CVS</title>
+<para>
+FIXME: presentation of cvs-buildpackage, updating sources
+via CVS (debian/rules refresh).
+<ulink url="http://www.debian.org/devel/cvs_packages">"http://www.debian.org/devel/cvs_packages"</ulink>
+</para>
+</section>
+-->
+
 <section id="bpp-debian-maint-scripts">
 <title>Best practices for maintainer scripts</title>
 <para>
@@ -1303,6 +1320,15 @@ easier, for instance, to keep URLs up to date across multiple files.
 
 <section id="bpp-common-situations">
 <title>Common packaging situations</title>
+<!--
+<section id="bpp-kernel">
+<title>Kernel modules/patches</title>
+<para>
+FIXME: Heavy use of kernel-package. provide files in
+/etc/modutils/ for module configuration.
+</para>
+</section>
+-->
 <section id="bpp-autotools">
 <title>Packages using <command>autoconf</command>/<command>automake</command></title>
 <para>
@@ -1417,9 +1443,30 @@ role="package">common-lisp-controller</systemitem>, about which see
 <filename>/usr/share/doc/common-lisp-controller/README.packaging</filename>.
 </para>
 </listitem>
+<!-- TODO: mozilla extension policy, once that becomes available -->
 </itemizedlist>
 </section>
 
+<!--
+<section id="custom-config-files">
+<title>Custom configuration files</title>
+<para>
+FIXME: speak of "ucf", explain solution with a template,
+explain conf.d directories
+</para>
+</section>
+<section id="config-with-db">
+<title>Use of an external database</title>
+<para>
+FIXME: The software may require a database that you need to setup.
+But the database may be local or distant. Thus you can't depend
+on a database server but just on the corresponding library.
+
+sympa may be an example package
+</para>
+</section>
+-->
+
 <section id="bpp-archindepdata">
 <title>Architecture-independent data</title>
 <para>
@@ -1613,6 +1660,7 @@ come from the upstream author(s), or whose contents has been changed by you.
 would lead to the source failing to build without assistance from the Debian
 diff, it might be appropriate to instead edit the files, omitting only the
 non-free parts of them, and/or explain the situation in a README.Debian-source
+<!-- or similarly named -->
 file in the root of the source tree.  But in that case please also urge the
 upstream author to make the non-free components easier seperable from the rest
 of the source.  </para> </footnote>