[PATCH 0/7] doc: Python 3 compat, rst2man.py support, etc.

[Tomi Ollila]

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

> I just bumped into this today while testing v2 of my
> content-description series:
>
>   $ ./configure
>   …
>   $ make
>   …
>   python ./doc/mkdocdeps.py ./doc doc/_build doc/docdeps.mk
>   Traceback (most recent call last):
>     File "./doc/mkdocdeps.py", line 6, in <module>
>       execfile(srcdir + '/conf.py')
>   NameError: name 'execfile' is not defined
>   …
>
> The first patch in this series fixes that issue, and the rest of the
> series fixes some other issues I bumped into while working on that.
> Sorry I missed these in the initial series.
>
> Note that while mkdocdeps.py and prerst2man.py are now Python 3
> compatible (with this series), the build will fail for Python's 3.0
> through 3.2 because of the explicit unicode literals in conf.py [1].
> It's likely that conf.py could use [2]
>
>   from __future__ import unicode_literals
>
> drop the u'' prefixes, and be compatible with all Python's ≥2.6
> (including all 3s).  I haven't checked the logic though, and I'm not
> running 3.2 locally anymore, so it's not a big priority for me.
>
> Cheers,
> Trevor
>
> [1]: https://docs.python.org/3/whatsnew/3.3.html#pep-414-explicit-unicode-literals
> [2]: from __future__ import unicode_literals
>
> W. Trevor King (7):
>   doc/mkdocdeps.py: Convert execfile to import
>   doc/mkdocdeps.py: Use "with" statement for the output file
>   doc/prerst2man.py: Use Python-3-compatible octal notation
>   doc/prerst2man.py: Fix 'os.system' -> 'system' typo
>   doc: Allow rst2man.py as an alternative to rst2man
>   doc/prerst2man.py: Convert execfile to import
>   doc/INSTALL: Remove rst2man reference and other updates

In this series IMO the patches 1-4:

id:8d518408f2da8bc96ae3123f05791142da26b9bc.1396718720.git.wking at tremily.us
id:543aee63407956e60f85dc11a2d25855e98c10c3.1396718720.git.wking at tremily.us
id:5e4509ab08699afe2681110fb35075e1d0bbdc7e.1396718720.git.wking at tremily.us
id:c5ec510ac25c867ad600c475a0070a003440a4b8.1396718720.git.wking at tremily.us

could go in as those are. 5:

id:adce76bb9a0ca728d856da4ecaf6b282e22e7440.1396718720.git.wking at tremily.us

if, for consistency reason (we don't use absolute paths with other commands
either), rst2man/rst2man.py is used as is (and commit message adjusted
accordingly).

patch 6:

id:7c43c614cb09665400544fc0928ac14bb67ceeb5.1396718720.git.wking at tremily.us

would be good as is, but it doesn't apply without 5

In 7:

id:edf9a674bc1f41917caead8d38b5f09295a9d1bd.1396718720.git.wking at tremily.us

In addition to David's comments, s/genric/generic/ ;D. I don't have opinion
whether INSTALL should be changed to README.rst. Maybe this is good idea;
that also distingush between ./INSTALL & doc/INSTALL. In this case 
`git grep INSTALL` shows that the line 83 in ./INSTALL needs to be changed,
too.

Tomi

PS: this id:<hash>.<timestamp>.git.<user at host> is PITA format to work with ;p

>
>  configure          | 12 +++++++-----
>  doc/INSTALL        | 34 ++++++++++++++++++++--------------
>  doc/Makefile.local |  6 +++---
>  doc/mkdocdeps.py   | 19 ++++++++++---------
>  doc/prerst2man.py  | 25 ++++++++++++++-----------
>  5 files changed, 54 insertions(+), 42 deletions(-)
>
> -- 
> 1.9.1.353.gc66d89d