summaryrefslogtreecommitdiffstats
path: root/tools/update-dbus-docs.py (follow)
Commit message (Collapse)AuthorAgeFilesLines
* tools: pylint update-dbus-docs.pyFrantisek Sumsal2023-08-101-40/+45
|
* man: also add anotations for methodsYu Watanabe2021-12-241-0/+8
| | | | Fixes #21882.
* update-dbus-docs: use color in summaryZbigniew Jędrzejewski-Szmek2021-02-061-1/+6
|
* update-dbus-docs: say "MODIFIED" not "OUTDATED"Zbigniew Jędrzejewski-Szmek2021-02-061-7/+8
| | | | | | When executed in test mode, "OUTDATED" is appropriate. But when executed to actually update the text, after the tool executes, those pages are the opposite, not outdated.
* tools: make update-dbus-docs compatible with Python 3.6Anita Zhang2021-02-011-1/+1
| | | | | | | 668b3a42fe9e250912bd3efa4460ed691452d9bf allowed update-dbus-docs.py to start running on Cent OS 8 (instead of skipping). But subprocess.check_output()'s text argument didn't exist until Python 3.7 and C8 is still running Python 3.6. Use universal_newlines instead for backwards compatibility.
* tools: make update-dbus-docs compatible with Python 3.7Luca Boccassi2021-01-291-3/+11
| | | | | Debian Stable uses Python 3.7, but there are a couple of 3.8 features used in the script. Add fallbacks.
* meson: rename target to update-dbus-docsZbigniew Jędrzejewski-Szmek2021-01-271-1/+1
| | | | | | | | | Very old versions of meson did not include the subdirectory name in the target name, so we started adding various "top-level" custom targets in subdirectories. This was nice because the main meson.build file wasn't as cluttered. But then meson started including the subdir name in the target name. So let's move the definition to the root so we can have all targets named uniformly.
* tools: drop unnecessary "else" after for loopYu Watanabe2020-11-201-2/+1
|
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* update-dbus-docs: skip test if python is too oldZbigniew Jędrzejewski-Szmek2020-09-201-5/+10
|
* update-dbus-docs: skip test lxml is not availableZbigniew Jędrzejewski-Szmek2020-09-181-7/+16
|
* update-dbus-docs: add hintZbigniew Jędrzejewski-Szmek2020-08-271-1/+2
|
* update-dbus-docs: omit verbose output when in --test modeZbigniew Jędrzejewski-Szmek2020-08-271-5/+5
| | | | It makes the ninja output listing very long for no good purpose.
* update-dbus-docs: add test modeZbigniew Jędrzejewski-Szmek2020-08-271-8/+19
|
* update-dbus-docs: use argparseZbigniew Jędrzejewski-Szmek2020-08-271-11/+12
|
* update-dbus-docs: print statistics at the endZbigniew Jędrzejewski-Szmek2020-08-271-6/+22
| | | | | | | | | | | | | | | | | Right now: org.freedesktop.LogControl1.xml: 3/3 org.freedesktop.home1.xml: 44/44 org.freedesktop.hostname1.xml: 21/21 org.freedesktop.import1.xml: 17/19 org.freedesktop.locale1.xml: 10/10 org.freedesktop.login1.xml: 172/172 org.freedesktop.machine1.xml: 49/65 org.freedesktop.resolve1.xml: 25/61 org.freedesktop.systemd1.xml: 214/1468 org.freedesktop.timedate1.xml: 12/12 total: 567/1875 :(
* update-dbus-docs: use executables in build/Zbigniew Jędrzejewski-Szmek2020-05-051-33/+21
|
* 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-2/+47
| | | | | Add a <variablelist/> tag after every programlisting we auto-generate that will be read by make-directive-index to cross-reference all dbus elements.
* update-dbus-docs: add support for settings printing just one selected interfaceZbigniew Jędrzejewski-Szmek2020-04-161-4/+10
| | | | | | So far the units there were being documented had only one custom interface. But for the pid1 case, something more flexibile is needed. So let's add an annotation in the page what we want to print, and filter in the generator.
* Add updater for dbus introspection in man pagesZbigniew Jędrzejewski-Szmek2020-04-161-0/+244
Compares to gdbus output, the values of properties are replaced by ellipses. For arrays and strings, the outer markers are kept. This is obviously also told by the type string, but it seems a bit easier to read this way. For any elements which are undocumented, a comment is inserted in sources. "Undocumented" means that the expected element was not found. This might require some adjustments if I missed some markup types. Invocation is manual: $ tools/update-dbus-docs.py tools/update-dbus-docs.py man/org.freedesktop.login1.xml $ tools/update-dbus-docs.py tools/update-dbus-docs.py man/org.freedesktop.resolve1.xml $ tools/update-dbus-docs.py tools/update-dbus-docs.py man/org.freedesktop.systemd1.xml ... If some object is not found on the bus, the existing output is retained. So the user needs to make sure that the appropriate objects have been instantiated before calling this. We don't change the dbus interface very often, so I think this manual mode is OK as a starting point. Making this fully automatic later would be nice of course.