axiom-developer
[Top][All Lists]
Advanced

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

Re: [Axiom-developer] Ping: file removals


From: Waldek Hebisch
Subject: Re: [Axiom-developer] Ping: file removals
Date: Sun, 5 Nov 2006 20:03:01 +0100 (CET)

> > | generated documentation files:
> > | 
> > |  src/doc/bookvol1.pdf
> > 
> > this call is slighlty harder.  We don't generate PDFs at the moment
> > (but we should), and this is a copy of a book already published.  So
> > the question is how "authentic" we want the copy in SVN to be.
> > Personnaly, I would go for its complete deletion, augment the build
> > machinery to generate PDF for documentation.  (I'm planning to put in
> > the PDF generatin anyway).
> 
> the pdf differs from the sources. the pdf is an exact copy of the
> published book as printed with the ISBN. there have been patches
> applied to the sources which people have submitted so the sources
> differ marginally, thus it is not possible to recreate the pdf
> unless you go into the archive and fetch the unpatched sources.
> 

I think that having two versions of bookvol1 is confusing for users.
Since later edits should improve the book (or update it to match
the program), I would opt for distributing with sources only the
latest version.
For people who want exact copy of published book we could provide
instructions how to fetch the pamphlet from the SCM (say add 
README.original-bookvol1).  Additionaly we can provide .pdf on
Axiom web site. 

One extra remark:  It make sense to put generated documentation
into distribution tarball, but IMHO generated files (with the exception
of files needed to bootstrap) should be removed from source archive.
And even for bootstrap files I think that we should remove them
from main source directory and put them in separate area (say
in subdirectories of 'bootstrap' directory, paralel to 'src').

-- 
                              Waldek Hebisch
address@hidden 




reply via email to

[Prev in Thread] Current Thread [Next in Thread]