summaryrefslogtreecommitdiff
path: root/make-man-index.py
AgeCommit message (Collapse)AuthorFilesLines
2013-03-29build-sys,man: use XML entities to substite stringsZbigniew Jędrzejewski-Szmek1-9/+7
This makes it easier to add substitutions to man pages, avoiding the separate transformation step. mkdir -p's are removed from the rule, because xsltproc will will create directories on it's own. All in all, two or three forks per man page are avoided, which should make things marginally faster. Unfortunately python parsers must too be tweaked to handle entities. This isn't particularly easy: with lxml a custom Resolver can be used, but the stdlib etree doesn't support external entities *at all*. So when running without lxml, the entities are just removed. Right now it doesn't matter, since the entities are not indexed anyway. But I intend to add indexing of filenames in the near future, and then the index generated without lxml might be missing a few lines. Oh well.
2013-03-09man: use lxml for faster generation and pretty printingZbigniew Jędrzejewski-Szmek1-2/+7
2013-03-07build-sys: check if manpage ids match file namesZbigniew Jędrzejewski-Szmek1-0/+7
Commit ed1553a fixed current errors, but this error is easy to make. A wrong id messes up the indexes and linking, so it is better to catch this automatically.
2013-02-06build-sys: create Makefile-man.am automaticallyZbigniew Jędrzejewski-Szmek1-1/+1
man rules were repeating the same information in too many places, which was error prone. Those rules can be easily generated from .xml files. For efficiency and because python is not a required dependency, Makefile-man.am is only regenerated when requested with make update-man-list If no metadata in man/*.xml changed, this file should not change. So only when a new man page or a new alias is added, this file should show up in 'git diff'. The change should then be committed. If the support for building from git without python was dropped, we could drop Makefile-man.am from version control. This would also increase the partial build time (since more stuff would be rebuild whenever sources in man/*.xml would be modified), so it would probably wouldn't be worth it.
2013-01-15make-man-index: work around UnicodeDecodeErrorZbigniew Jędrzejewski-Szmek1-1/+2
2013-01-15man: generate xml not html for indexZbigniew Jędrzejewski-Szmek1-62/+92
This way we also get a man page. The output is not as polished. I hope that it doesn't matter too much. index.html is not generated now, the page is called systemd.index.html. If necessary, an install hook should be added.
2013-01-04build-sys: invoke scripts with $PYTHON during buildZbigniew Jędrzejewski-Szmek1-1/+0
Python binary to be used during compilation can be set with ./configure PYTHON=... The she-bang line is removed, since it is not used anymore.
2012-09-13python: change license to LGPL 2.1Lennart Poettering1-0/+18
The original license has been MIT for this code, but David Strauss (its original author) agreed to relicense it to LGPL 2.1 for inclusion in systemd.
2012-07-25make-man-index.py: compatibility with Python 3Mantas Mikulėnas1-0/+2
Despite its name, ElementTree.tostring() returns already-encoded bytes() instead of a string in Python 3; sys.stdout doesn't like that.
2012-07-16make-man-index.py: pretty-print HTMLKay Sievers1-1/+17
2012-07-16man: actually generate h2 headers for letters in index as we meant toLennart Poettering1-1/+1
2012-07-16man: include number of man pages in index pageLennart Poettering1-0/+5
2012-07-16man: set description in italics in the indexLennart Poettering1-3/+6
2012-07-16man: show man page summary in index, tooLennart Poettering1-12/+9
2012-07-16min: generate an index page for all man pagesLennart Poettering1-0/+55
This makes use of python, if it is available