summaryrefslogtreecommitdiff
path: root/tools/make-directive-index.py
Commit message (Collapse)AuthorAgeFilesLines
* man: add "DNS resource record types" sectionZbigniew Jędrzejewski-Szmek2021-06-291-1/+2
|
* Revert "tools/make-directive-index: parallelize"Zbigniew Jędrzejewski-Szmek2021-05-141-42/+21
| | | | | | | | | | | This reverts commit a2031de849da52aa85b7e4326c0112ed7e5b5672. The patch itself seems OK, but it exposes a bug in lxml or libxml2-2.9.12 which was just released. This is being resolved in https://gitlab.gnome.org/GNOME/libxml2/-/issues/255, but it might be while. So let's revert this for now to unbreak our CI. Fixes #19601.
* tools/make-directive-index: parallelizeZbigniew Jędrzejewski-Szmek2021-05-131-21/+42
| | | | | | | | | | | | | | | | | | | | | | | | | | | | I occasionally do 'build/man/man systemd.directives' when working on man pages, and it's annoying slow. By paralellizing the parsing of xml, we can make it a bit faster. This is still rather innefficient. Only the parsing part is serialized, xml is still produced serially at the end, which is hard to avoid. $ ninja -C build man/systemd.directives.xml before: 8.20s user 0.21s system 99% cpu 8.460 total 8.33s user 0.18s system 98% cpu 8.619 total 8.72s user 0.19s system 98% cpu 9.019 total after: 13.99s user 0.73s system 345% cpu 4.262 total 14.15s user 0.35s system 348% cpu 4.161 total 14.33s user 0.35s system 339% cpu 4.321 total I.e. it uses almost twice as much cpu, but cuts the wallclock time down (on a 2-core/4-thread cpu) to about half too, which is an overall win if you're just trying to render the man page. The change from list and .append() to set and .add() is something that could have been done before too, but it's noticable now. It cuts down on the serialization/deserialization time (about .2s).
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* man: put all pages which mention a specifier in the indexZbigniew Jędrzejewski-Szmek2020-05-071-0/+3
| | | | | | I wasn't 100% convinced that this is the right thing to do, hence the separate commit. But e.g. for paths we index all mentions, so I think it's reasonable to do the same here.
* man: add specifiers section to directives indexZbigniew Jędrzejewski-Szmek2020-05-071-0/+9
| | | | | | The hack with getparent().txt is not very pretty, but the whole thing seems to work well enough. It is useful to figure out whihc specifiers are supported where.
* tools: move directive index template to separate fileZbigniew Jędrzejewski-Szmek2020-05-071-195/+6
| | | | | | | In the beginning, it was rather short, and reasonable to include inline. Now it is long and unwieldy, let's split it out. While at it, let's reindent and wrap using our current standards.
* tree-wide: fix spelling errorsFrantisek Sumsal2020-04-211-1/+1
| | | | | | Based on a report from Fossies.org using Codespell. Followup to #15436
* update-dbus-docs: automatically add variablelist for introspected itemsJérémy Rosen2020-04-201-0/+32
| | | | | Add a <variablelist/> tag after every programlisting we auto-generate that will be read by make-directive-index to cross-reference all dbus elements.
* make-directive-index: allow variablelist to specify an element to indexJérémy Rosen2020-04-201-0/+7
| | | | | | This commit looks for a new "extra-ref" attribute in <variablelist> If this attribute is specified, its content will be index as pointing to the current man-page in systemd.directives
* make-directive-index: allow pages to specify the path to searchJérémy Rosen2020-04-201-1/+2
| | | | | | | | So far, make-directive-index would look for ./valistentry/term/varname for elements to add to the directive man page. This commit allows to specify xpath= in the varlist directive to tell the generator what to look for.
* man: sort options without "=" in the directives indexZbigniew Jędrzejewski-Szmek2019-11-211-0/+3
| | | | | | | Some options would appear twice in the index, e.g. --collect= and --collect. Some man pages use one form, some the other, and the argument might be mandatory for some commands but not others. Anyway, let's display them as one entry, to reduce the total number of items listed.
* man: fix a few bogus entries in directives indexZbigniew Jędrzejewski-Szmek2019-11-211-1/+1
| | | | | | When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
* man: change noindex="true" to index="false"Zbigniew Jędrzejewski-Szmek2019-11-211-2/+2
| | | | We nowadays prefer positive options over negative.
* man: add a new section for EFI variablesZbigniew Jędrzejewski-Szmek2019-02-131-0/+10
| | | | | | | We should probably refer to them from other man pages for programs which use them, since right now all refs are in systemd-boot(7). But creating the section is a good step anyway.
* man: add a new directives section for .nspawnZbigniew Jędrzejewski-Szmek2019-02-131-1/+10
| | | | | | They is quite a bit of those directives and they were in "MISCELLANEOUS" because they don't quite fit anywhere. When the OCI-compat stuff is merged, there'll be even more, so let's make a separate section for them.
* man: move all config file options to one sectionZbigniew Jędrzejewski-Szmek2019-02-131-3/+3
| | | | | | We had "SYSTEM MANAGER DIRECTIVES" which was a misnomer already, because it also listed user manager stuff. Let's make this a more general section and move the items for other services there too (from "MISCELANENOUS").
* man: move os-release, machine-info, vconsole.conf vars to envvar sectionZbigniew Jędrzejewski-Szmek2019-02-131-2/+2
| | | | | Strictly speaking, those are not environment variables, but they are compatible and people think about them like this. Moving them makes them easier to find.
* tree-wide: drop header for emacs from python scriptsYu Watanabe2018-12-101-1/+0
|
* Merge pull request #9301 from keszybz/man-drop-authorgroupLennart Poettering2018-06-141-9/+0
|\ | | | | man: drop unused <authorgroup> tags from man sources
| * Also drop <authorgroup> from autogenerated pagesZbigniew Jędrzejewski-Szmek2018-06-141-9/+0
| |
* | Drop my copyright headersZbigniew Jędrzejewski-Szmek2018-06-141-2/+0
|/ | | | | | | perl -i -0pe 's/\s*Copyright © .... Zbigniew Jędrzejewski.*?\n/\n/gms' man/*xml git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/(#\n)?# +Copyright © [0-9, -]+ Zbigniew Jędrzejewski.*?\n//gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s*\/\*\*\*\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*?\s*\*\*\*\/\s*/\n\n/gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*//gms'
* tree-wide: beautify remaining copyright statementsLennart Poettering2018-06-141-1/+1
| | | | | | Let's unify an beautify our remaining copyright statements, with a unicode ©. This means our copyright statements are now always formatted the same way. Yay.
* tree-wide: drop 'This file is part of systemd' blurbLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | | | | | | This part of the copyright blurb stems from the GPL use recommendations: https://www.gnu.org/licenses/gpl-howto.en.html The concept appears to originate in times where version control was per file, instead of per tree, and was a way to glue the files together. Ultimately, we nowadays don't live in that world anymore, and this information is entirely useless anyway, as people are very welcome to copy these files into any projects they like, and they shouldn't have to change bits that are part of our copyright header for that. hence, let's just get rid of this old cruft, and shorten our codebase a bit.
* tree-wide: drop license boilerplateZbigniew Jędrzejewski-Szmek2018-04-061-13/+0
| | | | | | | | | | Files which are installed as-is (any .service and other unit files, .conf files, .policy files, etc), are left as is. My assumption is that SPDX identifiers are not yet that well known, so it's better to retain the extended header to avoid any doubt. I also kept any copyright lines. We can probably remove them, but it'd nice to obtain explicit acks from all involved authors before doing that.
* Add SPDX license headers to python scriptsZbigniew Jędrzejewski-Szmek2017-11-191-0/+1
|
* python: remove star importsZbigniew Jędrzejewski-Szmek2017-07-181-1/+1
| | | | | | Star imports are discouraged and break pyflakes. I'm happy to report that pyflakes finds no issues ;)
* more portable python shebangs (#5816)Jörg Thalheim2017-04-301-1/+1
| | | | | This is useful on systems like NixOS, where python3 is not in /usr/bin/python3 as well as for people using alternative ways to install python such as virtualenv/pyenv.
* Use python3 explicitly in all python scriptsFelipe Sateler2016-11-281-0/+1
|
* Remove systemd-bootchartDaniel Mack2016-02-231-9/+0
| | | | | | | This commit rips out systemd-bootchart. It will be given a new home, outside of the systemd repository. The code itself isn't actually specific to systemd and can be used without systemd even, so let's put it somewhere else.
* man: include the target name when linking to man pages in html outputZbigniew Jędrzejewski-Szmek2015-11-221-0/+1
| | | | | | | | | | | | | | | | | | | | | Links like http://www.freedesktop.org/software/systemd/man/systemd.socket.html are changed to http://www.freedesktop.org/software/systemd/man/systemd.socket.html#Accept=. This implementation is quick & dirty, and misses various corner cases. A fairly important one is that when a few directives share the same anchor (which happens when multiple directives are described in the same paragraph), generated links for everything except the first one link to an invalid anchor. Another shortcoming is that the formatting does not use the proper generateID machinery, so the anchor name could be wrong in some cases. But it seems to work for a large percentage of links, so seems to be an improvement in usability. When the anchor is missing, we land at the top of the page, which is the same as before. If the anchor were to point to different spot, this would be more confusing... Not sure if that ever happens. Anyway, the user should be able to recover from landing on the wrong place in the page. (Mostly) fixes https://github.com/systemd/systemd/issues/1956.
* s/command-line/command line/gLennart Poettering2014-11-061-1/+1
| | | | | | | | | | A follow-up to: commit 3f85ef0f05ffc51e19f86fb83a1c51e8e3cd6817 Author: Harald Hoyer <harald@redhat.com> Date: Thu Nov 6 15:33:48 2014 +0100 s/commandline/command line/g
* man: mention that x-systemd.device-timeout is only for fstabZbigniew Jędrzejewski-Szmek2014-06-301-2/+3
| | | | | | | | | Reformat fstab options description. Now they are easier to read and show up in systemd.directives(7). Use a single sublist for both /etc/fstab and /etc/crypttab options. Many of them can be used in both places. crypttab(5) is updated to use the same docbook elements, so formatting is uniform.
* build-sys: move python helpers to tools directoryKarel Zak2014-02-101-0/+320
Note that make-man-rules.py is missing in EXTRA_DIST=, this patch fixes this mistake too.