[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:
> Le Tue, Sep 27, 2011 at 05:45:02PM -0700, Russ Allbery a écrit :
>> Charles Plessy <plessy@debian.org> writes:

>>>  - 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

> Yes, this is what I have written, modulo the Makefile.

Yes, I know.  That's just part of the overall context for my whole
response which is now snipped out of that context.  :)

> I think that there is an advantage to not rebuild the HTML and TXT
> versions, as this guarantees that the distrubuted documents on
> www.debian.org will stay bit-identical.

I think ensuring rebuildability is somewhat more important than this.

> We can of course include a Makefile and make sure that the published
> versions are always rebuildable, but if jade and links change tiny
> details in the way they convert documents (whitespace,…), I think that
> it would not be a good reason to change the MD5 sum of the published
> versions.

I guess that doesn't really bother me.

>> The advantage of instead using:
>>     http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
>> 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.

> I proposed copyright-format-1.0 because it seemed to fit better David's
> requirements, as for the URI you propose the file name of the spec would
> be ‘index.html’.  For both URIs it looks equally easy to install the
> files.  I will follow the WWW team's choice for sure.

My assumption was that we would (for right now in the absence of needing
any supporting files) generate a single HTML file named
copyright-format-1.0.html, which the web team would then copy as
index.html into a directory named after the version number.

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

Reply to: