Folks,
I've been talking to Tim about where news files should go, and where
documents should be located. Here's the suggestion: squawk now if you
wish.
Define docprefix (not public) to be $prefix/share/doc if $prefix
contains '/star/', or $prefix/share/starlink/doc if $prefix doesn't
contain '/star/' (that is, if it's /usr/local or /opt or something).
Then define
starnewsdir=$docprefix/news
stardocsdir=$docprefix/<component-name>
That means that
starnews_DATA = <component>.news
stardocs_DATA = @STAR_LATEX_DOCUMENTATION@
will work. This results in all the news files going into one directory
as at present, though with a different name from the present, and all
the .tex and .htx files, along with any extra documentation associated
with a component, going in a component-based directory, rather than
into a single directory as at present. While there are some advantages
to having all the documentation in one directory, it would still be
useful to have any other documentation files associated with a
component be in a separate directory, for namespacing reasons if no
other. Keeping a component's SUNs and other documentation separate
would mean having to define and document stardocs_DATA _and_
starextradocs_DATA, with consequent confusion and brain-strain. This
would require no changes to Makefile.am files, since as long as they're
not naming the stardocsdir explicitly (and they shouldn't), they don't
have to care where it is.
If it were desirable to have all the SUNs in one place, then it would
I'm sure be possible to fiddle it, and have links to per-component SUNs
gathered together in one directory.
This change would require slight reworking of any tools which have
fixed expectations about the location of .htx files. As far as I know,
that means only the htx component -- is that correct? If so, I'll make
that change.
Any other impacts?
Norman
--
----------------------------------------------------------------------
Norman Gray : Physics & Astronomy, Glasgow University, UK
http://www.astro.gla.ac.uk/users/norman/ : www.starlink.ac.uk
|