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

Bug#649811: Publication of copyright-format 1.0, a.k.a DEP 5 (after it is accepted).


On 24/11/2011 02:39, Charles Plessy wrote:
> Le Thu, Nov 24, 2011 at 10:03:41AM +0900, Charles Plessy a écrit :
>> I think that we can be confident that DEP 5's URL will be:
>>   http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ 
>> (see http://bugs.debian.org/640737)
>> and that the debian-policy package will contain the documents in the
>> following files:
>>   /usr/share/doc/debian-policy/copyright-format-1.0.html
>>   /usr/share/doc/debian-policy/copyright-format-1.0.xml.tar.gz
>>   /usr/share/doc/debian-policy/copyright-format-1.0.txt.gz
> What is needed is more along the following.
> echo -n " copyright-format/1.0/"
> install -d -m 2775 $webdocdir/packaging-manuals/copyright-format/1.0/

Not really: we wanted the version number part of the file (inside the
debian-policy package) to avoid hardcoding it in the web build: we
really would prefer not to change the build each time a new
copyright-format is released (according to the stable update experience,
we can say for sure that what needs to be done will always be forgotten ;-).

> zcat dp/usr/share/doc/debian-policy/copyright-format-1.0.txt.gz > dp/copyright-format-1.0.txt
> install -p -m 664 dp/copyright-format-1.0.txt $webdocdir/packaging-manuals/copyright-format/1.0/index.txt

If we include the text file, I guess that keeping its name
(copyright-format-1.0.txt, or even copyright-format.txt since the URL is
already explicit) would be more meaningful than “index.txt”.

> install -p -m 664 dp/usr/share/doc/debian-policy/copyright-format-1.0.html $webdocdir/packaging-manuals/copyright-format/1.0/index.html
> One could do more complicated, having the file in 
> $webdocdir/packaging-manuals/copyright-format/1.0/copyright-format-1.0.html and
> $webdocdir/packaging-manuals/copyright-format/1.0/index.html linking to it.  Please
> let me know your preference.

That wouldn't be a good idea: symlinks will offer the exact same content
in two different URL, so its search engine ranking would be shared (i.e.
lower than it should).

Attached a crappy-untested-improvable patch that should address the
concerns. Once agreed on the text file name in the web tree, and the
patch tested and reviewed (and probably improved ;-), we could even
manage to make it work if and only if copyright-format-*.html actually
exists in the debian-policy package: as soon as the copyright-format-1.0
will actually be part of the debian-policy package, the file will show
up where it belongs, without any need to coordinate with the webmasters.

Of course, at least http://www.debian.org/doc/devel-manuals#policy will
still need an update, but the most important part will be done (and a
lot of people have commit access to webwml, so it's not an issue anyway).


From 977e9f5e57527c1d83142f129fc417b8f56d9606 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?David=20Pr=C3=A9vot?= <taffit@debian.org>
Date: Thu, 24 Nov 2011 23:00:42 -0400
Subject: [PATCH] Handle copyright-format
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: David Prévot <taffit@debian.org>
 parts/7doc |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/parts/7doc b/parts/7doc
index 3746258..0a3d592 100755
--- a/parts/7doc
+++ b/parts/7doc
@@ -48,6 +48,14 @@ 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
+# Add the copyright-format in its canonical place
+ver=`ls dp/usr/share/doc/debian-policy/copyright-format-*.html | sed 's/.*copyright-format-\(.*\)\.html/\1/'`
+echo -n " copyright-format-$ver"
+test -d "$webdocdir/packaging-manuals/copyright-format/$ver" || install -d -m 2775 "$webdocdir/packaging-manuals/copyright-format/$ver"
+install -p -m 664 -T dp/usr/share/doc/debian-policy/copyright-format-$ver.html $webdocdir/packaging-manuals/copyright-format/$ver/index.html
+zcat dp/usr/share/doc/debian-policy/copyright-format-$ver.txt.gz > dp/copyright-format-$ver.txt
+install -p -m 664 dp/copyright-format-$ver.txt $webdocdir/packaging-manuals/copyright-format/$ver/
 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/

Attachment: signature.asc
Description: OpenPGP digital signature

Reply to: