From mboxrd@z Thu Jan 1 00:00:00 1970 From: Olaf Hering Subject: Re: [PATCH] docs: install documentation which is referenced in man pages Date: Wed, 13 Jun 2012 15:13:52 +0200 Message-ID: <20120613131352.GA1275@aepfle.de> References: <1339514061.24104.81.camel@zakaz.uk.xensource.com> <20120613075853.GA22553@aepfle.de> <1339574778.24104.122.camel@zakaz.uk.xensource.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Content-Disposition: inline In-Reply-To: <1339574778.24104.122.camel@zakaz.uk.xensource.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Sender: xen-devel-bounces@lists.xen.org Errors-To: xen-devel-bounces@lists.xen.org To: Ian Campbell Cc: "xen-devel@lists.xensource.com" List-Id: xen-devel@lists.xenproject.org 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' 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