Re: Bug#609160: debian-policy: include DEP5

[Charles Plessy <plessy@debian.org>]

Dear Policy team and WWW team,

Here are two patches against the debian-policy package, in order to prepare the
distribution of our specification of a machine-readable format for
debian/copyright, drafted as Debian Enhancement Proposal number 5 (DEP 5) at
the following URL:

http://www.debian.org/doc/packaging-manuals/copyright-format/1.0

The first patch just catches up with changes sent by Lars as a driver, and the
second updates the URI to its final version.  Proofreading is appreciated.

After the debian-policy package is updated in unstable, it will be possible to
bring the specification on line by adding a couple of commands to the
parts/7doc cron script of our website, like with the attached patch.  Please
see it as an example only, and see also:

http://anonscm.debian.org/gitweb/?p=debwww/cron.git;a=blob;f=parts/7doc;h=4321c7ffaf32ce08294a9d198cf2d5b089fef0cd;hb=HEAD

Have a nice day,

-- 
Charles Plessy
Tsurumi, Kanagawa, Japan

>From 6a5eb1cff5a1e3c2499113ce4bc0a22cad14b4b8 Mon Sep 17 00:00:00 2001
From: Charles Plessy <plessy@debian.org>
Date: Tue, 6 Sep 2011 23:37:29 +0900
Subject: [PATCH 1/2] Patch from Lars Wirzenius that

 * removes drivers from abstract (we're mentioned in acks, which is
   enough)
 * corrects a couple of missing spaces from markup
 * removes of useless appendix (this was in dep svn already, so better do
   it in the version in policy too)

http://bugs.debian.org/609160#109
---
 copyright-format/copyright-format.xml |   31 +++----------------------------
 1 files changed, 3 insertions(+), 28 deletions(-)

diff --git a/copyright-format/copyright-format.xml b/copyright-format/copyright-format.xml
index 8ae9023..d6790aa 100644
--- a/copyright-format/copyright-format.xml
+++ b/copyright-format/copyright-format.xml
@@ -30,9 +30,7 @@
         standard, machine-readable format for
         <filename>debian/copyright</filename> files within packages and
         facilitate automated checking and reporting of licenses for packages and
-        sets of packages. The DEP drivers were Steve Langasek
-        <email>vorlon@debian.org</email> and Lars Wirzenius
-        <email>liw@liw.fi</email>.
+        sets of packages.
       </para>
     </abstract>
   </articleinfo>
@@ -143,7 +141,7 @@
         A white space separated list means that the field value may be on one
         line or many, but values in the list are separated by one or more white
         space characters (including space, TAB, and newline).  For example, the
-        <varname>Files</varname>field has a list of filename patterns.
+        <varname>Files</varname> field has a list of filename patterns.
       </para>
     </section>
 
@@ -273,7 +271,7 @@
           package, for instance when a work combines a permissive and a copyleft
           license, or to document a <emphasis>compilation copyright</emphasis>
           and license.  It is possible to use only <varname>License</varname> in
-          the header paragraph, but <varname>Copyright</varname>alone makes no
+          the header paragraph, but <varname>Copyright</varname> alone makes no
           sense.
         </para>
       </section>
@@ -1171,27 +1169,4 @@ License: GPL-2+
     </example>
   </section>
 
-  <section id="appendix">
-    <title>
-      Appendix: Note about the use of this format in Debian
-    </title>
-    <para>
-      The Debian Policy (§<ulink
-      url="http://www.debian.org/doc/debian-policy/ch-docs#s-copyrightfile";>12.5</ulink>)
-      demands that each package is accompanied by a file,
-      <filename>debian/copyright</filename> in source packages and
-      <filename>/usr/share/doc/package/copyright</filename> in binary packages,
-      that contains a verbatim copy of its copyright and distribution license.
-      In addition, it requires that copyrights must be extractable by mechanical
-      means.  This proposal for machine-readable copyright and license summary
-      files has been crafted for Debian's use, but it is our hope that other
-      software distributions, as well as upstream developers will adopt it, so
-      that review efforts can be easily reproduced and shared.
-    </para>
-    <para>
-      The copyright of the Debian packaging and the history of package
-      maintainers is simply indicated in a <literal>Files: debian/*</literal>
-      paragraph.
-    </para>
-  </section>
 </article>
-- 
1.7.5.4

>From 36a2cc0fdf953cbaf6996fd63b51f427439e33e2 Mon Sep 17 00:00:00 2001
From: Charles Plessy <plessy@debian.org>
Date: Tue, 6 Sep 2011 23:43:43 +0900
Subject: [PATCH 2/2] Use
 http://www.debian.org/doc/packaging-manuals/copyright-format/1.0
 as URI.

---
 copyright-format/copyright-format.xml |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/copyright-format/copyright-format.xml b/copyright-format/copyright-format.xml
index d6790aa..2f9cb10 100644
--- a/copyright-format/copyright-format.xml
+++ b/copyright-format/copyright-format.xml
@@ -185,7 +185,7 @@
         <title><varname>Format</varname></title>
         <para>
           Required single line: URI of the format specification, such as:
-          <literal>http://www.debian.org/doc/copyright-format/1.0</literal>
+          <literal>http://www.debian.org/doc/packaging-manuals/copyright-format/1.0</literal>
         </para>
       </section>
 
@@ -278,7 +278,7 @@
 
       <section id="example-header-paragraph">
         <title>Example header paragraph</title>
-<programlisting>Format: &lt;VERSIONED_FORMAT_URL&gt;
+<programlisting>Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0
 Upstream-Name: SOFTware
 Upstream-Contact: John Doe &lt;john.doe@example.com&gt;
 Source: http://www.example.com/software/project</programlisting>
@@ -1060,7 +1060,7 @@ also delete it here.</programlisting>
         A possible <filename>debian/copyright</filename> file for the program
         <quote>X Solitaire</quote> distributed in the Debian source package
         <literal>xsol</literal>:
-<programlisting><![CDATA[Format: <VERSIONED_FORMAT_URL>
+<programlisting><![CDATA[Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0
 Upstream-Name: X Solitaire
 Source: ftp://ftp.example.com/pub/games
 
@@ -1101,7 +1101,7 @@ License:
         A possible <filename>debian/copyright</filename> file for the program
         <quote>Planet Venus</quote>, distributed in the Debian source
         package <literal>planet-venus</literal>:
-<programlisting><![CDATA[Format: <VERSIONED_FORMAT_URL>
+<programlisting><![CDATA[Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0
 Upstream-Name: Planet Venus
 Upstream-Contact: John Doe <jdoe@example.com>
 Source: http://www.example.com/code/venus
-- 
1.7.5.4

>From eeb9b803a1c8fe64a44106d6b15a3c9b0dcb9cc9 Mon Sep 17 00:00:00 2001
From: Charles Plessy <plessy@debian.org>
Date: Wed, 7 Sep 2011 00:08:16 +0900
Subject: [PATCH] Install the machine-readable format for debian/copyright
 (DEP 5) in doc/packaging-manuals/copyright-format/1.0

---
 parts/7doc |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/parts/7doc b/parts/7doc
index 4321c7f..4faf8ec 100755
--- a/parts/7doc
+++ b/parts/7doc
@@ -51,6 +51,11 @@ install_policy_doc menu-policy packaging-manuals/menu-policy
 install_policy_doc perl-policy packaging-manuals/perl-policy
 install_policy_doc mime-policy packaging-manuals/mime-policy
 
+echo -n " copyright-format"
+zcat dp/usr/share/doc/debian-policy/copyright-format.txt.gz > dp/copyright-format.txt
+install -D -p -m 664 dp/copyright-format.txt $webdocdir/packaging-manuals/copyright-format/1.0.txt
+install -D -p -m 664 dp/usr/share/doc/debian-policy/copyright-format.html $webdocdir/packaging-manuals/copyright-format/1.0.html
+
 echo -n " upgrading-checklist"
 zcat dp/usr/share/doc/debian-policy/upgrading-checklist.txt.gz > dp/upgrading-checklist.txt
 install -p -m 664 dp/upgrading-checklist.txt $webdocdir/packaging-manuals/
-- 
1.7.5.4