[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#589605: debian-policy: A footnote to describe special first lines for changelogs.



Le Mon, Jul 19, 2010 at 10:14:41AM -0700, Russ Allbery a écrit :
> 
> How about something like:
> 
>     <footnote>
>       If the developer uploading the package is not one of the usual
>       maintainers of the package (as listed in the
>       <qref id="f-Maintainer"><tt>Maintainer</tt></qref> or
>       <qref id="f-Uploaders"><tt>Uploaders</tt></qref> control fields of
>       the package), the first line of the changelog is conventionally used
>       to explain why a non-maintainer is uploading the package.  The
>       Debian Developer's Reference (see <ref id="related">) documents the
>       conventions used.
>     </footnote>

I like it a lot. I attached it as a patch for your convenience.

Have a nice day,

-- 
Charles
>From 1b362ded3dcf54c8c97fa9b39c5b802de26a99d1 Mon Sep 17 00:00:00 2001
From: Charles Plessy <plessy@debian.org>
Date: Fri, 23 Jul 2010 11:06:45 +0900
Subject: [PATCH] Mention optional special role for the first changelog line as a footnote.

Points at the Debian Developer's Reference, that documents standardised
changelog first entries for NMU, QA, security and team uploads.
---
 policy.sgml |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/policy.sgml b/policy.sgml
index 847f716..19eea87 100644
--- a/policy.sgml
+++ b/policy.sgml
@@ -1636,7 +1636,15 @@
 	  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>
+	    If the developer uploading the package is not one of the usual
+	    maintainers of the package (as listed in the
+	    <qref id="f-Maintainer"><tt>Maintainer</tt></qref> or
+	    <qref id="f-Uploaders"><tt>Uploaders</tt></qref> control fields of
+	    the package), the first line of the changelog is conventionally used
+	    to explain why a non-maintainer is uploading the package.  The
+	    Debian Developer's Reference (see <ref id="related">) documents the
+	    conventions used.</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
-- 
1.6.5.7


Reply to: