(debian-policy.info)The extended description


Prev: The single line synopsis Up: The description of a package
Enter node , (file) or (file)node

3.4.2 The extended description
------------------------------

Do not try to continue the single line synopsis into the extended
description.  This will not work correctly when the full description is
displayed, and makes no sense where only the summary (the single line
synopsis) is available.

The extended description should describe what the package does and how
it relates to the rest of the system (in terms of, for example, which
subsystem it is which part of).

The description field needs to make sense to anyone, even people who
have no idea about any of the things the package deals with.  (1)

   ---------- Footnotes ----------

   (1) The blurb that comes with a program in its announcements and/or
‘README’ files is rarely suitable for use in a description.  It is
usually aimed at people who are already in the community where the
package is used.


automatically generated by info2www version 1.2.2.9