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

Bug#640737: [copyright-format] Point Format URL to www.debian.org.

Package: debian-policy
Version: 3.9.2.0

Dear Policy team,

Here is a patch to prepare the distribution of our specification for a
machine-readable Debian copyright file at the following URL:

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

URLs have been discussed earlier (see http://bugs.debian.org/609160#40).  I
removed the trailing slash, so that the file ‘copyright-format.html’ from this
package would be copied on www.debian.org under the name 1.0.html instead of
index.html, because it felt strange to me to refer to a document as a
directory.

I am completely open to make any change to this patch.  I have briefly
investigated how the sub-policies are made on-line, and while distributing the
copyright-format file(s) under doc/packaging-manuals is the most consistent
with current practices, it looks very straightforward to use other URLs.  So
there is room for improvement or forward-thinking (how to make it easy to
install multiple versions in parallel, as this URL suggests we would do ?).  On
the other hand, corrections can be made afterwards.  For me, it is open.  I do
not intend to promote one direction nor decide.

Here is the cron job that installs documents from the debian-policy package on
www.debian.org.

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



>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


-- 
Charles Plessy
Tsurumi, Kanagawa, Japan
Reply to: