summaryrefslogtreecommitdiff
path: root/make-directive-index.py
AgeCommit message (Collapse)Author
2013-05-30man: fix display of keys which appear in two sections in directive indexZbigniew Jędrzejewski-Szmek
When an index key appeared in multiple sections (e.g. CPUAffinity= was present in both "SYSTEM MANAGER DIRECTIVES" and "UNIT DIRECTIVES"), when lxml was used, the key would be not be displayed in all but one of those sections, and only an empty <term/> element would be present. This happens because lxml allows only one parent for each node, and when the same formatted element was used in multiple places, it was actually moved between them. Fix this by making a copy of the element. The bug was present since lxml support was introduced. Also fix some indentation issues.
2013-05-03man: add various filenames to the indexZbigniew Jędrzejewski-Szmek
Everything which is an absolute filename marked with <filename></filename> lands in the index, unless noindex= attribute is present. Should make it easier for people to find stuff when they are looking at a file on disk. Various formatting errors in manpages are fixed, kernel-install(1) is restored to formatting sanity.
2013-03-29build-sys,man: use XML entities to substite stringsZbigniew Jędrzejewski-Szmek
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-Szmek
2013-02-27man: drop rhs parts in snippets in directive indexZbigniew Jędrzejewski-Szmek
- --exit-if-exists=file + --exit-if-exists= etc.
2013-02-13man: add filenames to the indexZbigniew Jędrzejewski-Szmek
Limiting the addition to filenames from <refsynopsis> seems to give a good enough S/N ratio.
2013-02-06build-sys: create Makefile-man.am automaticallyZbigniew Jędrzejewski-Szmek
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-26make-directive-index: use original XML as index entriesZbigniew Jędrzejewski-Szmek
udev(7) fields are now display in whole, which looks much better.
2013-01-26man: extend systemd.directives(7) to all manual pagesZbigniew Jędrzejewski-Szmek
New sections are added: PAM options, crypttab options, commandline options, miscellaneous. The last category will be used for all untagged <varname> elements. Commandline options sections is meant to be a developer tool: when adding an option it is sometimes useful to be able to check if similarly named options exist elsewhere.
2013-01-15man: add links to directive index to see-alsosZbigniew Jędrzejewski-Szmek
systemd.directives(5) is renamed to systemd.directives(7). Section 7 is "Miscellaneous".
2013-01-15make-directive-index: link to systemd optionsZbigniew Jędrzejewski-Szmek
2013-01-15make-directive-index: count how many directives and pages are shownZbigniew Jędrzejewski-Szmek
2013-01-15make-directive-index: remove duplicated list of sectionsZbigniew Jędrzejewski-Szmek
2013-01-15man: add bootchart.conf to directives indexZbigniew Jędrzejewski-Szmek
2012-11-14lawyerese: add header to make-directive-indexZbigniew Jędrzejewski-Szmek
2012-09-17directive-index: journal directivesZbigniew Jędrzejewski-Szmek
2012-09-17directive-index: system manager directivesZbigniew Jędrzejewski-Szmek
2012-09-17directive-index: add UDEV fieldsZbigniew Jędrzejewski-Szmek
2012-09-17man: generate an index of directivesZbigniew Jędrzejewski-Szmek
Systemd has a large (and growing) number of manpages. Sometimes it's not immediately obvious, where to look for a directive. Especially, when something is described in more than one place. Making sense of all the settings should be easier with an index.