summaryrefslogtreecommitdiffstats
path: root/man/sd_event_add_time.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-19/+19
| | | | | This is just a slight markup improvement; there should be no difference in rendering.
* man: condense version information for functionsAbderrahim Kitouni2023-09-191-8/+9
| | | | 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/+12
|
* man: add version infoAbderrahim Kitouni2023-08-291-1/+3
| | | | | | | | 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.
* tree-wide: when in doubt use greek small letter mu rather than micro symbolLennart Poettering2023-06-141-8/+8
| | | | | | | | Doesn't really matter since the two unicode symbols are supposedly equivalent, but let's better follow the unicode recommendations to prefer greek small letter mu, as per: https://www.unicode.org/reports/tr25
* sd-event: store and compare per-module static origin idLuca Boccassi2023-04-251-1/+1
| | | | | | | | | sd-event objects use hashmaps, which use module-global state, so it is not safe to pass a sd-event object created by a module instance to another module instance (e.g.: when two libraries static linking sd-event 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.
* man: add better descriptions of what event handlers doZbigniew Jędrzejewski-Szmek2022-01-051-18/+23
| | | | | The meaning of the return value, the default handlers, and loop exiting are now described.
* man: properly list relative time event source API in man pageLennart Poettering2020-11-101-0/+2
| | | | | The content was already there, but it wasn't listed in the header metadata. Fix that.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* sd-event: support callback=NULL in IO/child/inotify/defer event sources, tooLennart Poettering2020-10-071-6/+4
| | | | | | | | | | | | | | | | | Also, document this functionality more prominently, including with a reference from sd_event_exit(). This is mostly to make things complete, as previously we supported NULL callbacks only in _add_time() and _add_signal(). However, I think this makes snese for IO event sources too (think: when some fd such as a pipe end sees SIGHUP or so, exit), as well as defer or post event sources (i.e. exit once we got nothing else to do). This also adds support for inotify event sources, simply to complete things (I can't see the immediate use, but maybe someone else comes up with it). The only event source type that doesn't allow callback=NULL now are exit callbacks, but for them they make little sense, as the event loop is exiting then anyway.
* man: document new relative time APIs in sd-eventLennart Poettering2020-07-281-10/+43
|
* man: document sd_event_source_set_floating()Lennart Poettering2019-11-281-0/+1
| | | | | | Let's make sure we get back to 100% man page documentation coverage of our sd-event APIs. We are bad enough at the others, let's get these ones right at least.
* man: make separate "Errors" sections subsection of "Return value"Zbigniew Jędrzejewski-Szmek2019-03-211-30/+30
| | | | | | | | 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: 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-9/+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: remove Lennart's copyright linesLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | These lines are generally out-of-date, incomplete and unnecessary. With SPDX and git repository much more accurate and fine grained information about licensing and authorship is available, hence let's drop the per-file copyright notice. Of course, removing copyright lines of others is problematic, hence this commit only removes my own lines and leaves all others untouched. It might be nicer if sooner or later those could go away too, making git the only and accurate source of authorship information.
* 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.
* man: document the new sd_event_add_inotify() callLennart Poettering2018-06-061-0/+1
|
* 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
|
* Various fixes for typos found by lintian (#3705)Michael Biebl2016-07-121-1/+1
|
* man: fix indefinite articles (#3694)Jakub Wilk2016-07-121-2/+2
|
* sd-event: permit a USEC_INFINITY timeout as an alternative to a disabling an ↵Lennart Poettering2016-02-011-35/+22
| | | | | | | event source This should simplify handling of time events in clients and is in-line with the USEC_INFINITY macro we already have. This way setting a timeout to 0 indicates "elapse immediately", and a timeout of USEC_INFINITY "elapse never".
* man/sd_event_{add_io,add_time,add_signal,now}: various small fixesZbigniew Jędrzejewski-Szmek2016-01-191-39/+41
| | | | | | | | - remove things which are clear from the context - 0 is a valid descriptor number, hence "positive" → "non-negative" - "positive" means greater than zero, hence "positive non-zero" → "positive" - use oxford comma - reword some things for clarity
* man: fix typosJakub Wilk2015-12-261-2/+2
|
* man: fully document sd-event interfacesLennart Poettering2015-11-191-51/+116
| | | | | | | | | This completes the set of man pages for sd-event and contains some minor other fixes for other man pages too. The sd_event_set_name(3) man page is renamed to sd_event_source_set_description(3), which is the correct name of the concept today.
* man: revert dynamic paths for split-usr setupsTom Gundersen2015-06-181-4/+1
| | | | | | | | | | | | | | | | | | | | | | | This did not really work out as we had hoped. Trying to do this upstream introduced several problems that probably makes it better suited as a downstream patch after all. At any rate, it is not releaseable in the current state, so we at least need to revert this before the release. * by adjusting the path to binaries, but not do the same thing to the search path we end up with inconsistent man-pages. Adjusting the search path too would be quite messy, and it is not at all obvious that this is worth the effort, but at any rate it would have to be done before we could ship this. * this means that distributed man-pages does not make sense as they depend on config options, and for better or worse we are still distributing man pages, so that is something that definitely needs sorting out before we could ship with this patch. * we have long held that split-usr is only minimally supported in order to boot, and something we hope will eventually go away. So before we start adding even more magic/effort in order to make this work nicely, we should probably question if it makes sense at all.
* man: always build sd-bus man pages, even if kdbus is disabledLennart Poettering2015-06-171-1/+1
| | | | | After all, we now moved sd-bus out of the kdbus conditional, hence the man pages should be too.
* man: generate configured paths in manpagesFilipe Brandenburger2015-05-281-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In particular, use /lib/systemd instead of /usr/lib/systemd in distributions like Debian which still have not adopted a /usr merge setup. Use XML entities from man/custom-entities.ent to replace configured paths while doing XSLT processing of the original XML files. There was precedent of some files (such as systemd.generator.xml) which were already using this approach. This addresses most of the (manual) fixes from this patch: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220 The idea of using generic XML entities was presented here: http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html This patch solves almost all the issues, with the exception of: - Path to /bin/mount and /bin/umount. - Generic statements about preference of /lib over /etc. These will be handled separately by follow up patches. Tested: - With default configure settings, ran "make install" to two separate directories and compared the output to confirm they matched exactly. - Used a set of configure flags including $CONFFLAGS from Debian: http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules Installed the tree and confirmed the paths use /lib/systemd instead of /usr/lib/systemd and that no other unexpected differences exist. - Confirmed that `make distcheck` still passes.
* tree-wide: there is no ENOTSUP on linuxDavid Herrmann2015-03-131-1/+1
| | | | Replace ENOTSUP by EOPNOTSUPP as this is what linux actually uses.
* man: boilerplate unificationZbigniew Jędrzejewski-Szmek2015-02-111-12/+12
|
* man: add emacs header to get correct indention in nxml-mode for the manpage ↵Lennart Poettering2014-11-211-1/+1
| | | | | | | | XML files that use 2ch indenting In the long run we really should figure out if we want to stick with 8ch or 2ch indenting, and not continue with half-and-half. For now, just make emacs aware of the files that use 2ch indenting.
* man: use <constant> markup for errno valueZbigniew Jędrzejewski-Szmek2014-09-261-5/+5
| | | | | We were inconsistent, but marking them up as constants makes more sense then as variables.
* man: document sd_event_add_{defer,post,exit}Zbigniew Jędrzejewski-Szmek2014-09-261-0/+1
|
* man: add sd_event_add_child(3)Zbigniew Jędrzejewski-Szmek2014-09-261-0/+1
|
* man: add sd_event_add_signal(3)Zbigniew Jędrzejewski-Szmek2014-09-261-6/+18
|
* man: add a mapping for external manpagesZbigniew Jędrzejewski-Szmek2014-07-081-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
* doc: balance C indirections in function prototypesJan Engelhardt2014-05-081-2/+2
| | | | | | | | Shift the asterisks in the documentation's prototypes such that they are consistent among each other. Use the right side to match what is used in source code. Addendum to commit v209~82.
* doc: comma placement corrections and word orderJan Engelhardt2014-05-081-3/+3
| | | | | Set commas where there should be some. Some improvements to word order.
* man: document sd_event_add_time(3)Lennart Poettering2014-05-061-0/+245