Re: [Xen-devel] [PATCH] docs: install documentation which is referenced in man pages

[Olaf Hering <olaf@xxxxxxxxx>]

On Wed, Jun 13, Ian Campbell wrote:

> On Wed, 2012-06-13 at 08:58 +0100, Olaf Hering wrote:
> > On Tue, Jun 12, Ian Campbell wrote:
> > 
> > > On Mon, 2012-06-11 at 16:56 +0100, Olaf Hering wrote:
> > > > xl.cfg.5 refers to non-existant files named xl-disk-configuration and
> > > > xl-network-configuration. Adjust to new DOCDIR location.
> > > 
> > > The reason for omitting the extension is that it can be .html or .txt
> > > depending on the context which the link is given in.
> > 
> > How is that link ' F<xl-network-configuration>' supposed to be filled?
> > I think F refers to a local filename.
> 
> F<..> just means "format as a filename i.e. italics", it doesn't turn
> into an actual link even in html. I should have said "reference" rather
> than "link" I think.

So how should I handle that part then? Leaving it alone for the time
being? That would be fine with me.

> > > > +DOC_MAN_REFS    := misc/sedf_scheduler_mini-HOWTO.txt \
> > > > +                       misc/xl-disk-configuration.txt \
> > > > +                       misc/vbd-interface.txt \
> > > > +                       misc/xl-network-configuration.markdown
> > > 
> > > Any reason not to install the whole of $(DOC_TXT) instead of just this
> > > subset?
> > 
> > Most of it looks like developer documentation to me. In the end
> > kexec_and_kdump.txt, vtd.txt and perhaps the xen cmdline docu could be
> > installed in addition to the files above.
> 
> Perhaps we should be splitting the misc dir up into user and dev etc?

I think that will just cause unneeded churn. The list of user
documentation files can be maintained in Makefile variable such as
DOCS_TO_INSTALL.

Olaf

_______________________________________________
Xen-devel mailing list
Xen-devel@xxxxxxxxxxxxx
http://lists.xen.org/xen-devel