Re: [Xen-devel] [PATCH DOCDAY] use lynx to produce better formatted text documentation from markdown

[Matt Wilson <msw@xxxxxxxxxx>]

On Tue, Aug 07, 2012 at 01:23:02AM -0700, Ian Campbell wrote:
> On Tue, 2012-08-07 at 04:22 +0100, Matt Wilson wrote:
> > On Tue, Jul 31, 2012 at 08:34:59AM -0700, Matt Wilson wrote:
> > > > Why wouldn't you just run lynx on the generated .html instead of less on
> > > > the generated .txt if you wanted something a bit better formatted?
> > > 
> > > I generally don't have lynx installed on my production machines.
> 
> You can read it on your workstation or on line at
> http://xenbits.xen.org/docs/unstable/misc/xen-command-line.html
> 
> > Any further concerns?
> 
> I'm afraid I just don't see the point. The plain markdown docs are
> serviceable enough, if not great, and there are plenty of ways to view
> the html docs both on and off line if you want something prettier,
> without adding a web browser to our build dependencies.

I'm certainly not suggesting that we add a web browser to the build
dependencies. If lynx isn't installed, the current behavior of copying
the markdown file is maintained.

If a packager wishes to produce prettier text documentation, they can
elect to add lynx to their build dependencies. Today doing this
post-build from build control files is a bit tricky, since we drop the
semantic information conveyed by the .markdown suffix by calling the
final file .txt.

4.2 will be the first release with markdown documentation. I think
that making it well formatted, just as the previous .txt
documentation, will be a better experience for the user.

Matt

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