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

Re: Source code location?



> In article <[🔎] m0zeKcm-000IiwC@polya>, jdg@maths.qmw.ac.uk (Julian
> Gilbey) writes:
> 
> > I am trying to repackage a new upstream Stanford GraphBase (sgb).  I
> > would like to include the source code in the .deb package, as the
> > value of the included programs is really as a demonstration of what
> > the library code can do (libgb), and the documentation of the
> > library is in its literate source code.
> 
> Hmm. Interesting.  So how do you use it?  You *extend* the library?
> Or you just read about it? ;)

You use the library as any library by linking it to your code.
However, imagine if some library had no independent documentation
other than well documented source code.  And I mean SO well documented
that it's a pleasure to read, and even enjoy.  That's what the SGB
library is like.  (In fact, it's so readable that it's been published
as a book.  Being written in CWEB means that you can create TeXable
output from the source code, which can be pretty-printed.)

> > So here's the question: where do I place the CWEB source code?  Do I
> > put it in:
> 
> >  o /usr/share/sgb although the use of /usr/share is not particularly
> > well documented, or
> 
> It's documented in the FHS standard,
> <URL:http://www.pathname.com/fhs/>, which is not officially sanctioned
> by policy, but, nevertheless, is the right place for architecture
> independant *data* files (or scripts).

No, it is required by policy (section 3.1.1, version 2.5.0.0).

> My gut feeling would be under /usr/doc/sgb/examples, I suppose.

OK, I'll go for that, thanks.  Would it be out of order to include a
symlink /usr/doc/sgb/src -> /usr/doc/sgb/examples?  I hope not.

   Julian

=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-

            Julian Gilbey             Email: J.D.Gilbey@qmw.ac.uk
       Dept of Mathematical Sciences, Queen Mary & Westfield College,
                  Mile End Road, London E1 4NS, ENGLAND
      -*- Finger jdg@goedel.maths.qmw.ac.uk for my PGP public key. -*-


Reply to: