From: Russ Allbery Date: Wed, 2 Jun 2010 16:37:39 +0000 (-0700) Subject: Remove documentation of alternative changelog formats X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=53bbb84eadf79b3635b1b002c1fcae4a13333eaf;p=debian%2Fdebian-policy.git Remove documentation of alternative changelog formats Remove documentation of alternative changelog formats. This feature is not allowed in the Debian archive and will be documented in the dpkg-dev documentation instead. The documentation that was in Policy was also somewhat outdated. (Closes: #555009, see #584141) --- diff --git a/debian/changelog b/debian/changelog index 0c616c9..9c3c7c8 100644 --- a/debian/changelog +++ b/debian/changelog @@ -30,6 +30,10 @@ debian-policy (3.8.5.0) UNRELEASED; urgency=low * Standardize dpkg state wording and bring it in line with dpkg, renaming Failed-Config to Half-Configured and use uniform capitalization and punctuation. (Closes: #442134) + * Remove documentation of alternative changelog formats. This feature + is not allowed in the Debian archive and will be documented in the + dpkg-dev documentation instead. The documentation that was in Policy + was also somewhat outdated. (Closes: #555009, see #584141) -- Bill Allombert Mon, 31 May 2010 20:00:28 +0200 diff --git a/policy.sgml b/policy.sgml index 96a77b8..5f26cec 100644 --- a/policy.sgml +++ b/policy.sgml @@ -9983,120 +9983,6 @@ END-INFO-DIR-ENTRY

- - - debian/changelog - -

- See . -

- - Defining alternative changelog formats - - -

- It is possible to use a different format to the standard - one, by providing a parser for the format you wish to - use. -

- -

- In order to have dpkg-parsechangelog run your - parser, you must include a line within the last 40 lines - of your file matching the Perl regular expression: - \schangelog-format:\s+([0-9a-z]+)\W The part in - parentheses should be the name of the format. For - example, you might say: - - @@@ changelog-format: joebloggs @@@ - - Changelog format names are non-empty strings of alphanumerics. -

- -

- If such a line exists then dpkg-parsechangelog - will look for the parser as - /usr/lib/dpkg/parsechangelog/format-name - or - /usr/local/lib/dpkg/parsechangelog/format-name; - it is an error for it not to find it, or for it not to - be an executable program. The default changelog format - is dpkg, and a parser for it is provided with - the dpkg package. -

- -

- The parser will be invoked with the changelog open on - standard input at the start of the file. It should read - the file (it may seek if it wishes) to determine the - information required and return the parsed information - to standard output in the form of a series of control - fields in the standard format. By default it should - return information about only the most recent version in - the changelog; it should accept a - -vversion option to return changes - information from all versions present strictly - after version, and it should then be an - error for version not to be present in the - changelog. -

- -

- The fields are: - - Source - Version (mandatory) - Distribution (mandatory) - Urgency (mandatory) - Maintainer (mandatory) - Date - Changes (mandatory) - -

- -

- If several versions are being returned (due to the use - of -v), the urgency value should be of the - highest urgency code listed at the start of any of the - versions requested followed by the concatenated - (space-separated) comments from all the versions - requested; the maintainer, version, distribution and - date should always be from the most recent version. -

- -

- For the format of the Changes field see - . -

- -

- If the changelog format which is being parsed always or - almost always leaves a blank line between individual - change notes these blank lines should be stripped out, - so as to make the resulting output compact. -

- -

- If the changelog format does not contain date or package - name information this information should be omitted from - the output. The parser should not attempt to synthesize - it or find it from other sources. -

- -

- If the changelog does not have the expected format the - parser should exit with a nonzero exit status, rather - than trying to muddle through and possibly generating - incorrect output. -

- -

- A changelog parser may not interact with the user at - all. -

- - - debian/substvars and variable substitutions