tag 640737 + patch thanks Dear all,
to summarise: * http://www.debian.org/doc/packaging-manuals/copyright-format/<version>/ will allow the copyright-format specification to become a multi-page HTML document if it gets significantly expanded, but on the other hand, somebody downloading the current one-page spec will get a file called ‘index.html’. * Rebuilding the distributed document at each upload may cause it to change in layout or in checksum, but on the other hand ensures that it is continuously buildable. My point of view is that the copyright-format specification is not likely to be enlarged to the point of neeeding to separate its chapters in different files (there is SPDX…) and that the source document uses only simple DocBook 4.5 tags which makes it very unlikely to become unbuildable with the default XSL stylesheet it uses. Moreover, I am biased by the culture in my profession to not change even a single comma of a published work, so my personnal preference would have been to distribute files like copyright-format-1.0.html, committed with their source in the debian-policy Git repository. This said, this point of view had no support from other participants in this discussion. So I propose to do the following, in line with the other propositions. a) Apply the attached patch to point at http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ in the spec. b) When the 1.0 version is finalised, (re)build at each upload copyright-format/copyright-format.xml, copyright-format/copyright-format-1.0.xml, and so on for the future revisions. c) Distribute the versionned and unversionned HTML and text builds in the debian-policy binary package. (Assuming that if since nobody proposed to stop distributing the unversionned build, it is that people want it to stay). I will propose a patch to implement the building and distribution of released versions and current draft, but before doing so, I would like to know if it would be acceptable to have them in /usr/share/doc/debian-policy, or if the published versions should be in a separate directory. Have a nice day, -- Charles
>From f1458e166554bcb1928e7d74e54af5ea873d8dc4 Mon Sep 17 00:00:00 2001 From: Charles Plessy <ple...@debian.org> Date: Wed, 5 Oct 2011 22:22:22 +0900 Subject: [PATCH] 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..c4e47b3 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: <VERSIONED_FORMAT_URL> +<programlisting>Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/; Upstream-Name: SOFTware Upstream-Contact: John Doe <john....@example.com> 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 <j...@example.com> Source: http://www.example.com/code/venus -- 1.7.5.4