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

Re: Bug#640737: [copyright-format] Format URL and installation on www.debian.org (Re: Bug#640737: [copyright-format] misc. changes from driver.)

Charles Plessy <plessy@debian.org> writes:

> Here is one simple solution:

>  - In the debian-policy package, copyright-format/copyright-format.xml is the
>    working document, which contains a disclaimer and a reference to the stable
>    version on www.debian.org.

>  - Published versions are stored in the debian-policy in
>    copyright-format/published/, as XML source and HTML and text
>    documents, without makefile as they are final versions, under names
>    like copyright-format/published/copyright-format-1.0.html.

I think we should include the source in case anyone wants to fork an old
version of the document (plus just on general principles of always
retaining source for anything we publish), and if we're going to include
the source we should ensure it remains buildable, so my inclination is to
only include the source in the Git repository for debian-policy and keep
generating the HTML for old versions.  This requires changing the
documents if anything about the toolchain for generating HTML changes, but
hopefully such changes should be minor.

>  - The ‘7doc’ cron job on www.debian.org installs a hard-coded list of
>    copyright-format versions, on URIs like
>    ‘http://www.debian.org/doc/packaging-manuals/copyright-format-1.0.html’;
>    Depending how often the spec is updated (hopefully not often), the
>    file listing in http://www.debian.org/doc/packaging-manuals/ will
>    grow, but if it really becomes a problem, the directory could get a
>    proper WML index.

>  - Thanks to content negociation on www.debian.org, the current URI for
>    the spec would be
>    http://www.debian.org/doc/packaging-manuals/copyright-format-1.0

The advantage of instead using:


is that, when one is using a simple mapping from URLs to file space, if
for some reason the document ever needs to be broken into multiple files
or needs to have images, the URL already assumes each document is in its
own directory and keeps all those supporting files isolated from each
other for multiple versions.

There are, of course, ways of arranging this for any URL format, but this
one probably keeps the overall complexity down the most.

Russ Allbery (rra@debian.org)               <http://www.eyrie.org/~eagle/>

Reply to: