summaryrefslogtreecommitdiff
path: root/man/sd_bus_message_read_basic.xml
Commit message (Collapse)AuthorAgeFilesLines
* sd-bus/man: document EBUSY error in bus_message_read (#21954)lincoln auster2022-01-111-3/+3
| | | | | | | | | | | | | | | | * sd-bus/man: document EBUSY error in bus_message_read The EBUSY error can be returned from sd_bus_exit_container(), and, if that happens, it will be propogated upwards towards bus_message_read. In terms of documentation, this means that bus_message_read's man page can't just include the error text for sd_bus_message_read_basic, as reading basic types exclusively doesn't have the potential for this error. sd_bus_message_read_basic's error documentation isn't incorrect when applied to sd_bus_message_read, it's just incomplete. While EBUSY is documented in sd_bus_message_open_container.xml, it's explanation is unique to the sd_bus_message_exit_container function and makes for poor documentation of the general read API.
* man: fix grammaroZbigniew Jędrzejewski-Szmek2021-02-251-5/+5
|
* man: slightly update the man page of sd_bus_message_read_basic()Yu Watanabe2020-11-251-1/+1
| | | | Follow-up for 73a1d7d2433edd1872ec53db3e804009298ebb1d.
* man: Fixed an incomplete sentenceigo958622020-11-251-1/+1
|
* man: Specify that sd_bus_message_read_basic returns 0 if end of array had ↵igo958622020-11-251-3/+3
| | | | been reached.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* man: document fd ownership for sd-bus fd marshallingLennart Poettering2020-08-301-11/+13
| | | | Fixes: #8003
* typo: stringy -> stringMark Deneen2020-02-261-1/+1
|
* man: clarify that we decode D-Bus bools as "int", not as C99 "bool"Lennart Poettering2020-01-281-1/+1
| | | | Fixes: #14643
* man: describe types slightly more accuratelyLennart Poettering2020-01-281-11/+11
|
* man: enclose C type names in <type></type>Lennart Poettering2020-01-281-16/+16
|
* man: make separate "Errors" sections subsection of "Return value"Zbigniew Jędrzejewski-Szmek2019-03-211-20/+20
| | | | | | | | 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: add sd_bus_message_skip(3)Zbigniew Jędrzejewski-Szmek2018-08-111-0/+1
|
* Merge pull request #9490 from keszybz/document-sd_message_readLennart Poettering2018-07-031-10/+152
|\ | | | | Document sd_bus_message_read
| * man: document sd_bus_read(), add more about sd_bus_read_basic()Zbigniew Jędrzejewski-Szmek2018-07-031-10/+152
| |
* | man: drop mode line in file headersZbigniew Jędrzejewski-Szmek2018-07-031-1/+1
|/ | | | | This is already included in .dir-locals, so we don't need it in the files themselves.
* man: drop unused <authorgroup> tags from man sourcesZbigniew Jędrzejewski-Szmek2018-06-141-8/+0
| | | | | | | | | | | | Docbook styles required those to be present, even though the templates that we use did not show those names anywhere. But something changed semi-recently (I would suspect docbook templates, but there was only a minor version bump in recent years, and the changelog does not suggest anything related), and builds now work without those entries. Let's drop this dead weight. Tested with F26-F29, debian unstable. $ perl -i -0pe 's/\s*<authorgroup>.*<.authorgroup>//gms' man/*xml
* 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 identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: document some sd-bus functions (#3567)mahkoh2016-06-211-0/+113
* sd_bus_add_match * sd_bus_get_fd * sd_bus_message_read_basic * sd_bus_process
View Lorry Controller Status