Chapter 12. Documentation
Packages distributed under the UCB BSD license, the Artistic license, the GNU
GPL, and the GNU LGPL should refer to the files
respectively, rather than quoting them
in the copyright file.
You should not use the copyright file as a general
file. If your package has such a file
it should be installed in
other appropriate place.
Any examples (configurations, source files, whatever), should be installed in a directory
. These files should not be referenced by any program:
they're there for the benefit of the system administrator and users as documentation only.
Architecture specific example files should be installed in a directory
with symbolic links to them from
the latter directory itself may be a symbolic link to the former.
If the purpose of a package is to provide examples, then the example files may be installed into
12.7 Changelog files
Packages that are not Debian native must contain a compressed copy of the
file from the Debian source tree in
with the name
If an upstream changelog is available, it should be accessible as
in plain text. If the upstream changelog is distributed in HTML, it should
be made available in that form as
a plain text
should be generated from it using, for example,
. If the upstream changelog files do not already conform to this naming convention,
then this may be achieved either by renaming the files, or by adding a symbolic link, at the
All of these files should be installed compressed using
, as they will become large
with time even if they start out small.
If the package has only one changelog which is used both as the Debian changelog and the
upstream one because there is no separate upstream maintainer then that changelog should
usually be installed as
; if there is a separate
Rationale: People should not have to look in places for upstream changelogs merely because they are given
different names or are distributed in HTML format.