From 2f922c3f2bf6bd30cd15a4599bb4f4c4cf1cc471 Mon Sep 17 00:00:00 2001 From: Manoj Srivastava Date: Thu, 16 Jun 2005 05:34:34 +0000 Subject: [PATCH] * removed the obsolete notion of documenting changes within the copyright Author: joy Date: 2002/11/15 02:49:48 * removed the obsolete notion of documenting changes within the copyright file, which closes: #65764, and cleared up the overall mess regarding changelogs with a nicer new introductory stuff in the changelogs section and more cross-references * merged the section on accessing the additional documentation within the generic section since it's just one paragraph now, and fits in nicely; also made it say "has been" instead of "has now" in order to make the Policy independent of a specific point in time * moved the note about /usr/share/doc/foo being a symlink to the generic section about the additional documentation, it didn't belong only to the section about changelogs git-archimport-id: srivasta@debian.org--etch/debian-policy--devel--3.0--patch-152 --- policy.sgml | 98 +++++++++++++++++++++++++++-------------------------- 1 file changed, 50 insertions(+), 48 deletions(-) diff --git a/policy.sgml b/policy.sgml index b9bc231..5e7bd25 100644 --- a/policy.sgml +++ b/policy.sgml @@ -1390,38 +1390,12 @@ reconfigure the package if necessary. You should not configure the package and edit the generated Makefile! This makes it impossible for - someone else to later reconfigure the package.

- - - - Documenting your changes + someone else to later reconfigure the package.

You should document your changes and updates to the source - package properly in the debian/changelog file. (Note - that mistakes in changelogs are usually best rectified by - making a new changelog entry rather than "rewriting history" - by editing old changelog entries.)

- -

- In non-experimental packages you must use a format for - debian/changelog which is supported by the most - recent released version of dpkg. -

- If you wish to use an alternative format, you may do - so as long as you include a parser for it in your - source package. The parser must have an API - compatible with that expected by - dpkg-genchanges and - dpkg-gencontrol. If there is general - interest in the new format, you should contact the - dpkg maintainer to have the parser - script for it included in the dpkg - package. (You will need to agree that the parser and - its manpage may be distributed under the GNU GPL, just - as the rest of `dpkg' is.) -

- + package properly in the debian/changelog file. + For more information, please see .

@@ -7625,14 +7599,16 @@ install-info --quiet --remove /usr/share/info/foobar.info from /usr/share/doc/package/.

- - - - Accessing the documentation +

+ /usr/share/doc/package may be a symbolic + link to another directory in /usr/share/doc only if + the two packages both come from the same source and the + first package Depends on the second. +

Former Debian releases placed all additional documentation - in /usr/doc/package. This has now + in /usr/doc/package. This has been changed to /usr/share/doc/package, and packages must not put documentation in the directory /usr/doc/package. @@ -7683,9 +7659,7 @@ install-info --quiet --remove /usr/share/info/foobar.info

In addition, the copyright file must say where the upstream - sources (if any) were obtained, and should explain briefly what - modifications were made in the Debian version of the package - compared to the upstream one. It should name the original + sources (if any) were obtained. It should name the original authors of the package and the Debian maintainer(s) who were involved with its creation.

@@ -7740,16 +7714,51 @@ install-info --quiet --remove /usr/share/info/foobar.info

- + Changelog files +

+ The Debian changelog file (debian/changelog) should + explain briefly what modifications were made in the Debian version + of the package compared to the upstream one. Other changes and + updates to the package should also be documented in this file. +

+ +

+ Mistakes in changelogs are usually best rectified by + making a new changelog entry rather than "rewriting history" + by editing old changelog entries. +

+ +

+ The format of the debian/changelog file is described + in . In non-experimental packages you must + use a format for debian/changelog which is supported + by the most recent released version of dpkg. +

+ If you wish to use an alternative format, you may do so as long + as you include a parser for it in your source package. The + parser must have an API compatible with that expected by + dpkg-genchanges and dpkg-gencontrol. + If there is general interest in the new format, you should + contact the dpkg maintainer to have the + parser script for it included in the dpkg package. + (You will need to agree that the parser and its manpage may be + distributed under the GNU GPL, just as the rest of `dpkg' is.) +

+ +

+

Packages that are not Debian-native must contain a compressed copy of the debian/changelog file from the Debian source tree in /usr/share/doc/package with the name - changelog.Debian.gz. If an upstream changelog is - available, it should be accessible as + changelog.Debian.gz. +

+ +

+ If an upstream changelog is available, it should be accessible as /usr/share/doc/package/changelog.gz in plain text. If the upstream changelog is distributed in HTML, it should be made available in that form as @@ -7768,14 +7777,6 @@ install-info --quiet --remove /usr/share/info/foobar.info

-

- /usr/share/doc/package may be a symbolic - link to another directory in /usr/share/doc only if - the two packages both come from the same source and the - first package Depends on the second. -

- -

All of these files should be installed compressed using gzip -9, as they will become large with time even @@ -7791,6 +7792,7 @@ install-info --quiet --remove /usr/share/info/foobar.info there is a separate upstream maintainer, but no upstream changelog, then the Debian changelog should still be called changelog.Debian.gz.

+ -- 2.39.5