summaryrefslogtreecommitdiffstats
path: root/man/sd_bus_set_description.xml (follow)
Commit message (Collapse)AuthorAgeFilesLines
* man: use same version in public and system ident.David Tardon2023-12-251-1/+1
|
* man: use <simplelist> for 'See also' sectionsDavid Tardon2023-12-231-8/+8
| | | | | This is just a slight markup improvement; there should be no difference in rendering.
* man: use meaningful titles for <ulink>sZbigniew Jędrzejewski-Szmek2023-11-061-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | As pointed out in https://github.com/systemd/systemd/issues/29814, we need to use phrases are are meaningful on their own, because the man page formatter creates a list at the bottom. With <ulink>see docs</ulink>, we end up with: NOTES: 1. see docs https://some.url/page 2. see docs https://some.url/page2 which is not very useful :( Also, the text inside the tag should not include punctuation. Python helper: from xml_helper import xml_parse for p in glob.glob('../man/*.xml'): t = xml_parse(p) ulinks = t.iterfind('.//ulink') for ulink in ulinks: if ulink.text is None: continue text = ' '.join(ulink.text.split()) print(f'{p}: {text}')
* man: condense version information for functionsAbderrahim Kitouni2023-09-191-11/+11
| | | | Use a more compact form like 'a, b, and c were added in version x'
* man: add version information for functionsAbderrahim Kitouni2023-09-041-0/+15
|
* man: add version infoAbderrahim Kitouni2023-08-291-2/+6
| | | | | | | | This tries to add information about when each option was added. It goes back to version 183. The version info is included from a separate file to allow generating it, which would allow more control on the formatting of the final output.
* sd-bus: store and compare per-module static origin idLuca Boccassi2023-04-251-1/+1
| | | | | | | | | sd-bus objects use hashmaps, which use module-global state, so it is not safe to pass a sd-bus object created by a module instance to another module instance (e.g.: when two libraries static linking sd-bus are pulled in a single process). Initialize a random per-module origin id and store it in the object, and compare it when entering a public API, and error out if they don't match, together with the PID.
* docs: use https:// for fd.o linksZbigniew Jędrzejewski-Szmek2022-01-121-1/+1
|
* man: correct return value of sd_bus_open_with_descriptionLuca Boccassi2021-07-061-2/+5
| | | | | | Since https://github.com/systemd/systemd/commit/f4b2933ee7890e5d414ab266d8586f19027a2bd9 if a description is not set, sd_bus_open_with_description returns -ENXIO, but the documnetation stated that it returned successfully with a NULL string.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* sd-bus: Add sd_bus_get_scope/tid/unique_name docsDaan De Meyer2020-04-211-1/+56
|
* sd-bus: Rewrap sd_bus_set_description docsDaan De Meyer2020-04-201-39/+35
|
* Merge pull request #15153 from keszybz/man-bus-addressZbigniew Jędrzejewski-Szmek2020-03-191-4/+22
|\ | | | | Add two man pages for sd-bus
| * man: say "is" not "has been"Zbigniew Jędrzejewski-Szmek2020-03-181-3/+3
| |
| * man: mention sd_bus_is_anonymous() and sd_bus_is_trusted()Zbigniew Jędrzejewski-Szmek2020-03-181-1/+19
| |
* | sd-bus: sd_bus_set/get_method_call_timeout docs + cleanups.Daan De Meyer2020-03-181-2/+2
|/
* man: merge items specified as separate lists into one listZbigniew Jędrzejewski-Szmek2019-05-091-8/+0
|
* man: make separate "Errors" sections subsection of "Return value"Zbigniew Jędrzejewski-Szmek2019-03-211-36/+36
| | | | | | | | Logically, this is better, because we're describing a subset of possible return values. Visually this also looks quite good because groff renders refsect2 much less prominently. Also rewrap things, add <constant> in various places, fix some typos.
* man: use same header for all filesZbigniew Jędrzejewski-Szmek2019-03-141-2/+2
| | | | | | | The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
* man: standarize on one-line license headerZbigniew Jędrzejewski-Szmek2019-03-141-4/+1
| | | | | | No need to waste space, and uniformity is good. $ perl -i -0pe 's|\n+<!--\s*SPDX-License-Identifier: LGPL-2.1..\s*-->|\n<!-- SPDX-License-Identifier: LGPL-2.1+ -->|gms' man/*.xml
* man: add sd_bus_set_description(3)Zbigniew Jędrzejewski-Szmek2018-07-161-0/+188