Bug#589605: debian-policy: A footnote to describe special first lines for changelogs.
On 19/07/10 07:20, Charles Plessy wrote:
> Package: debian-policy
> Version: 3.9.0.0
> Severity: wishlist
> Tags: patch
>
> Dear all,
>
> during the discussion about team uploads (http://wiki.debian.org/TeamUpload),
> it was proposed to send a patch to the Policy, to include a footnotes that
> reminds that sometimes the first line of a changelog has a special meaning, and
> point at the Developer's Reference for more information.
>
> Here is tha patch:
>
> diff --git a/policy.sgml b/policy.sgml
> index 0b3c1a1..e64b18b 100644
> --- a/policy.sgml
> +++ b/policy.sgml
> @@ -1608,7 +1608,24 @@
> The maintainer name and email address used in the changelog
> should be the details of the person uploading <em>this</em>
> version. They are <em>not</em> necessarily those of the
> - usual package maintainer. The information here will be
> + usual package maintainer<footnote>
> + When the developer uploading the pacakge is not listed in
package
> + the <qref id="f-Maintainer"><tt>Maintainer</tt></qref> or
> + <qref id="f-Uploaders"><tt>Uploaders</tt></qref> fields,
> + the first line of the changelog may be used to indicate
> + a justification of the upload. In particular, the following
> + lines are currently used:
> + <example>
> + * Non-maintainer upload.
> + * Non-maintainer upload by the Security Team.
> + * QA upload.
> + * Binary-only non-maintainer upload for <var>architecture</var>; no source changes.
> + * Team upload.
> + </example>
> + Most of these uses are described in more details in the <tt><url
detail?
> + name="Debian Deveper's Reference"
> + id="http://www.debian.org/doc/developers-reference/";></tt>.
> + </footnote>. The information here will be
> copied to the <tt>Changed-By</tt> field in the
> <tt>.changes</tt> file (see <ref id="f-Changed-By">),
> and then later used to send an acknowledgement when the
That looks like a big footnote :) Perhaps you could make the examples list not
exhaustive? E.g. just put one example, you're cross-referencing dev-ref where
you say they are documented anyway.
Regards,
Emilio
Reply to: