[PATCH v2 1/5] doc: Allow rst2man.py as an alternative to rst2man

[Tomi Ollila]

On Sat, May 10 2014, "W. Trevor King" <wking at tremily.us> wrote:

> Gentoo's dev-python/docutils-0.10 installs Docutils scripts with a
> *.py extension, so I have /usr/bin/rst2man.py and no rst2man script.
> This patch supports users with both types of systems by checking for
> rst2man, falling back on rst2man.py, and giving up only if neither is
> found.  Users can also set the new RST2MAN path variable explicitly
> when they call Make:
>
>   make RST2MAN=/my/custom/rst_to_man_converter build-man
>
> I use POSIX's 'command -v' [1] to find the path to rst2man or
> rst2man.py, and save that as RST2MAN in Makefile.config.  Then pass
> the configured RST2MAN path through to prerst2man.py to use in its
> system call.

The comment block above can be removed if the change I suggest below will
be done...

>
> We can use a non-empty RST2MAN to check for the availability of an
> rst2man program, so there's no need for a separate HAVE_RST2MAN.
> However, we keep the existing HAVE_RST2MAN for consistency with
> HAVE_SPHINX.
>
> [1]: http://pubs.opengroup.org/onlinepubs/9699919799/utilities/command.html

ditto

> ---
>  configure          | 15 +++++++++++++--
>  doc/Makefile.local |  2 +-
>  doc/prerst2man.py  |  9 +++++----
>  3 files changed, 19 insertions(+), 7 deletions(-)
>
> diff --git a/configure b/configure
> index 9bde2eb..f017af8 100755
> --- a/configure
> +++ b/configure
> @@ -413,17 +413,24 @@ if hash sphinx-build > /dev/null 2>&1 && python -m sphinx.writers.manpage > /dev
>      printf "Yes.\n"
>      have_sphinx=1
>      have_rst2man=0
> +    RST2MAN=
>  else
>      printf "No (falling back to rst2man).\n"
>      have_sphinx=0
>  
>      printf "Checking if rst2man is available... "
>      if rst2man -V > /dev/null 2>&1; then
> -       printf "Yes.\n"
>         have_rst2man=1
> +       RST2MAN=$(command -v rst2man)

This could be just RST2MAN=rst2man -- for consistency -- otherwise we'd
need to give the same treatment to all other commands we check...


> +       printf "Yes (${RST2MAN}).\n"
> +    elif rst2man.py -V > /dev/null 2>&1; then
> +       have_rst2man=1
> +       RST2MAN=$(command -v rst2man.py)

Ditto, RST2MAN=rst2man.py


> +       printf "Yes (${RST2MAN}).\n"
>      else
> -       printf "No (so will not install man pages).\n"
>         have_rst2man=0
> +       RST2MAN=
> +       printf "No (so will not install man pages).\n"
>      fi
>  fi

Tomi