git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@2185
313b444b-1b9f-4f58-a734-
7bb04f332e8d
<!entity % commondata SYSTEM "common.ent" > %commondata;
<!-- CVS revision of this document -->
<!entity % commondata SYSTEM "common.ent" > %commondata;
<!-- CVS revision of this document -->
- <!entity cvs-rev "$Revision: 1.187 $">
+ <!entity cvs-rev "$Revision: 1.188 $">
<!-- if you are translating this document, please notate the CVS
revision of the developers reference here -->
<!--
<!-- if you are translating this document, please notate the CVS
revision of the developers reference here -->
<!--
than <file>/bin</file>, so one can't use it in scripts which are run
before the <file>/usr</file> partition is mounted. Most scripts won't have
this problem, though.
than <file>/bin</file>, so one can't use it in scripts which are run
before the <file>/usr</file> partition is mounted. Most scripts won't have
this problem, though.
- <sect id="bpp-debian-control">
+ <sect id="bpp-debian-control">
<heading>Best practices for <file>debian/control</file></heading>
<p>
The following practices are relevant to the
<heading>Best practices for <file>debian/control</file></heading>
<p>
The following practices are relevant to the
and the long description for the package.
and the long description for the package.
<sect1 id="bpp-desc-basics">
<heading>General guidelines for package descriptions</heading>
<p>
<sect1 id="bpp-desc-basics">
<heading>General guidelines for package descriptions</heading>
<p>
Windows", "X-Windows", or "X Window". Use "GTK+", not "GTK" or "gtk".
Use "GNOME", not "Gnome". Use "PostScript", not "Postscript" or
"postscript".
Windows", "X-Windows", or "X Window". Use "GTK+", not "GTK" or "gtk".
Use "GNOME", not "Gnome". Use "PostScript", not "Postscript" or
"postscript".
<sect1 id="bpp-pkg-synopsis">
<sect1 id="bpp-pkg-synopsis">
with the package name in the following way:
<example>The <var>package-name</var> is a <var>synopsis</var>.</example>
with the package name in the following way:
<example>The <var>package-name</var> is a <var>synopsis</var>.</example>
- <p>
-If the package name is an acronym, it is sometimes useful to expand
-the acronym. For instance, the synopsis for <package>vim</package> is
-"Vi IMproved - enhanced vi editor".
-
<sect1 id="bpp-pkg-desc">
<heading>The long description</heading>
<sect1 id="bpp-pkg-desc">
<heading>The long description</heading>
package related to other packages in some way that is not handled by
the package manager (e.g., "this is the client to the foo server")?
<p>
package related to other packages in some way that is not handled by
the package manager (e.g., "this is the client to the foo server")?
<p>
+Be objective. Package descriptions are not the place for advocating
+your package, no matter how much you love it. Remember that the
+reader may not care about the same things you care about.
+ <p>
Be careful to avoid spelling and grammar mistakes. Ensure that you
spell-check it. <prgn>ispell</prgn> has a special <tt>-g</tt> option
for <file>debian/control</file> files:
<example>ispell -d american -g debian/control</example>
Be careful to avoid spelling and grammar mistakes. Ensure that you
spell-check it. <prgn>ispell</prgn> has a special <tt>-g</tt> option
for <file>debian/control</file> files:
<example>ispell -d american -g debian/control</example>
<sect1 id="bpp-upstream-info">
<heading>Upstream home page</heading>
<p>
<sect1 id="bpp-upstream-info">
<heading>Upstream home page</heading>
<p>
id="&url-eg-desc-upstream-info;">.
<p>
If there is no home page for the software, this should naturally be
id="&url-eg-desc-upstream-info;">.
<p>
If there is no home page for the software, this should naturally be
<p>
Note that we expect this field will eventually be replaced by a proper
<file>debian/control</file> field understood by <prgn>dpkg</prgn> and
<p>
Note that we expect this field will eventually be replaced by a proper
<file>debian/control</file> field understood by <prgn>dpkg</prgn> and