Обсуждение: Documentation tree (again)
OK, so when I asked earlier about documentation directory structure,
Marc indicated that we should put things into a separate area, not just
plop them into the usual src/ tree. I agree, but am not sure _where_ to
actually put them.
I am thinking of making a directory doc/src/sgml (under the existing doc
directory) which would contain the sgml source code. doc/src would
contain that and a Makefile which would know how to invoke the Makefile
in doc/src/sgml. A "make install" from doc/src would copy gzip packaged
files up to doc/, where they would be for a distribution.
A Makefile in doc/ would unpack the gzip tar files of html into
directories right under doc/, such as doc/tutorial, doc/userguide, etc.
Is this OK? Some questions:
1) Should all html be isolated into subdirectories under a doc/html/
directory?
2) Should documentation source be somewhere other than doc/src/?
Remember that the doc directory is at the same level as the src/
directory for the executable source code distribution, not underneath
it.
3) The top level Makefile will be very simple at first (I won't have
time for more), and will just install directly into the doc/ directory
tree. Is this OK? If not, does someone want to volunteer to do more??
Opinions/comments?
- Tom
On Thu, 26 Feb 1998, Thomas G. Lockhart wrote:
> OK, so when I asked earlier about documentation directory structure,
> Marc indicated that we should put things into a separate area, not just
> plop them into the usual src/ tree. I agree, but am not sure _where_ to
> actually put them.
>
> I am thinking of making a directory doc/src/sgml (under the existing doc
> directory) which would contain the sgml source code. doc/src would
> contain that and a Makefile which would know how to invoke the Makefile
> in doc/src/sgml. A "make install" from doc/src would copy gzip packaged
> files up to doc/, where they would be for a distribution.
>
> A Makefile in doc/ would unpack the gzip tar files of html into
> directories right under doc/, such as doc/tutorial, doc/userguide, etc.
>
> Is this OK? Some questions:
Sounds good to me...
> 1) Should all html be isolated into subdirectories under a doc/html/
> directory?
I'd say that all html should be installed in $prefix/html when a
'make install' is issued. You should be able to remove the package after
installing...
Marc G. Fournier
Systems Administrator @ hub.org
primary: scrappy@hub.org secondary: scrappy@{freebsd|postgresql}.org
> I'd say that all html should be installed in $prefix/html when a
> 'make install' is issued. You should be able to remove the package after
> installing...
Which "the package": the source distribution tar files or the $prefix/html target
area?
- Tom
On Fri, 27 Feb 1998, Thomas G. Lockhart wrote:
> > I'd say that all html should be installed in $prefix/html when a
> > 'make install' is issued. You should be able to remove the package after
> > installing...
>
> Which "the package": the source distribution tar files or the
> $prefix/html target area?
The source distribution...
Marc G. Fournier
Systems Administrator @ hub.org
primary: scrappy@hub.org secondary: scrappy@{freebsd|postgresql}.org