xen-devel.lists.xenproject.org archive mirror
 help / color / mirror / Atom feed
From: Matt Wilson <msw@amazon.com>
To: Ian Jackson <Ian.Jackson@eu.citrix.com>
Cc: xen-devel@lists.xen.org
Subject: [PATCH 0 of 3] improve checking for documentation tools and formatting
Date: Wed, 29 Aug 2012 14:01:12 -0700	[thread overview]
Message-ID: <patchbomb.1346274072@u002268147cd4502c336d.ant.amazon.com> (raw)

This patch series is a follow up to a change that I posed for the last
Xen Documentation Day that used lynx to create plain text from
markdown files. I've added ./configure time checking for all the tools
used in the docs/ tree. The user can persistently override one of
these tools at ./configure time by setting the appropriate environment
variable. The docs/ tree maintains the list of default tools, so
running ./configure is not a prerequisite for running "make -C docs".

I've switched to using elinks instead of lynx for creating text
documentation, as it provides better formatting and interface compared
to other tools. Of course the user can override the tool and flags if
they'd like to use something else.

Here's a sample of ./configure output after this series is applied:

checking for ps2pdf... /usr/bin/ps2pdf
checking for dvips... no
configure: WARNING: dvips is not available so some documentation won't be built
checking for latex... no
configure: WARNING: latex is not available so some documentation won't be built

Please let me know if there are other concerns that need to be
addressed.

Matt

             reply	other threads:[~2012-08-29 21:01 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-08-29 21:01 Matt Wilson [this message]
2012-08-29 21:01 ` [PATCH 1 of 3] tools: check for documentation generation tools at configure time Matt Wilson
2012-08-30 15:39   ` Ian Jackson
2012-08-29 21:01 ` [PATCH 2 of 3] docs: use elinks to format markdown-generated html to text Matt Wilson
2012-08-30 15:41   ` Ian Jackson
2012-08-30 15:47     ` Keir Fraser
2012-08-30 16:41       ` Matt Wilson
2012-08-30 15:47     ` Ian Campbell
2012-08-30 16:54     ` Matt Wilson
2012-08-29 21:01 ` [PATCH 3 of 3] tools/docs: allow markdown_py to be used Matt Wilson
2012-08-30 15:40   ` Ian Jackson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=patchbomb.1346274072@u002268147cd4502c336d.ant.amazon.com \
    --to=msw@amazon.com \
    --cc=Ian.Jackson@eu.citrix.com \
    --cc=xen-devel@lists.xen.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).