summaryrefslogtreecommitdiff
path: root/man/sd-id128.xml
Commit message (Collapse)AuthorAgeFilesLines
* man: add libsystemd(3)Zbigniew Jędrzejewski-Szmek2023-05-151-5/+7
| | | | | | | | Before libsystemd-daemon, libsystemd-journal, libsystemd-id128, etc., were merged into libsystemd, it was enough to have individual man pages for them. But they have been delivered as one thing for many years, so it's better to have a landing page for libsystemd. It mostly directs to individual pages anyway.
* man: document sd_id128_string_equal()Zbigniew Jędrzejewski-Szmek2022-06-301-0/+11
|
* man: rework the text in sd-id128Zbigniew Jędrzejewski-Szmek2022-06-301-45/+108
| | | | | | | | | | | | | In places the text was overly formal, e.g. "an 128-bit ID" was repeated, even though it is clear from the context that we're talking about this type of ID. OTOH, in other places the text was informal, e.g. "You can use …". Also, "you may use f() to frob" → "f() frobs". The text without all the flourishes is easier to read. sd_id128_in_set_sentinel() was described only in passing when taking about sd_id128_in_set(), now it gets is own brief paragraph. The synopsis was missing.
* man: document SD_ID128_ALLFLennart Poettering2021-08-201-1/+4
|
* sd-id128: add SD_ID128_MAKE_UUID_STRZbigniew Jędrzejewski-Szmek2021-06-151-4/+7
| | | | It's like SD_ID128_MAKE_STR, but with hyphens.
* sd-id128: document everywhere that we treat all UUIDs as Variant 1Lennart Poettering2021-06-151-12/+13
| | | | | | | | So in theory UUID Variant 2 (i.e. microsoft GUIDs) are supposed to be displayed in native endian. That is of course a bad idea, and Linux userspace generally didn't implement that, i.e. uuidd and similar. Hence, let's not bother either, but let's document that we treat everything the same as Variant 1, even if it declares something else.
* sd-id128: add convenience functions to compare multiple sd_id128_tZbigniew Jędrzejewski-Szmek2021-04-211-0/+29
| | | | | | | | | Similar to sd_bus_error_has_names() that was added in 2b07ec316a0e25a3e10c270c7f6baee9e0187bf8. It is made inline in the hope that the compiler will be able to optimize all the va_args boilerplate away, and do an efficient comparison when the arguments are all constants.
* man: mention sd_id128_is_allf(), SD_ID128_ALLFZbigniew Jędrzejewski-Szmek2021-04-211-9/+14
| | | | | It was added in 670814387ba8973245c08123e7240669f51a55a8, but not mentioned in the man pages.
* man: dedent examples in sd-id128 to 2 columnsZbigniew Jędrzejewski-Szmek2021-04-211-16/+16
| | | | | | | | In man pages, horizontal space it at premium, and everything should generally be indented with 2 spaces to make it more likely that the examples fit on a user's screen. C.f. 798d3a524ea57aaf40cb53858aaa45ec702f012d.
* man: set constant tag to NUL or NULLYu Watanabe2020-11-121-3/+4
|
* man: append parentheses for function nameYu Watanabe2020-11-121-5/+4
|
* man: fix tagYu Watanabe2020-11-121-1/+1
|
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* sd-id128: expose ID128_UUID_FORMAT_STRZbigniew Jędrzejewski-Szmek2019-04-051-0/+6
| | | | | It is generally useful, and can be made public in the same manner that SD_ID128_FORMAT_STR is.
* man: use same header for all filesZbigniew Jędrzejewski-Szmek2019-03-141-1/+1
| | | | | | | 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
* tree-wide: drop all references to "journalctl --new-id128"Lennart Poettering2018-10-021-2/+2
| | | | Let's advertise "systemd-id128 new" instead.
* 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.
* tree-wide: drop spurious newlines (#8764)Lennart Poettering2018-04-191-1/+0
| | | | | | | | Double newlines (i.e. one empty lines) are great to structure code. But let's avoid triple newlines (i.e. two empty lines), quadruple newlines, quintuple newlines, …, that's just spurious whitespace. It's an easy way to drop 121 lines of code, and keeps the coding style of our sources a bit tigther.
* 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: sd-id128: fix journalctl option name (#5381)Lucas Werkmeister2017-02-181-1/+1
| | | | --new-id works because it’s an unambiguous prefix, but the full option name is --new-id128.
* tree-wide: add SD_ID128_MAKE_STR, remove LOG_MESSAGE_IDZbigniew Jędrzejewski-Szmek2017-02-151-1/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Embedding sd_id128_t's in constant strings was rather cumbersome. We had SD_ID128_CONST_STR which returned a const char[], but it had two problems: - it wasn't possible to statically concatanate this array with a normal string - gcc wasn't really able to optimize this, and generated code to perform the "conversion" at runtime. Because of this, even our own code in coredumpctl wasn't using SD_ID128_CONST_STR. Add a new macro to generate a constant string: SD_ID128_MAKE_STR. It is not as elegant as SD_ID128_CONST_STR, because it requires a repetition of the numbers, but in practice it is more convenient to use, and allows gcc to generate smarter code: $ size .libs/systemd{,-logind,-journald}{.old,} text data bss dec hex filename 1265204 149564 4808 1419576 15a938 .libs/systemd.old 1260268 149564 4808 1414640 1595f0 .libs/systemd 246805 13852 209 260866 3fb02 .libs/systemd-logind.old 240973 13852 209 255034 3e43a .libs/systemd-logind 146839 4984 34 151857 25131 .libs/systemd-journald.old 146391 4984 34 151409 24f71 .libs/systemd-journald It is also much easier to check if a certain binary uses a certain MESSAGE_ID: $ strings .libs/systemd.old|grep MESSAGE_ID MESSAGE_ID=%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x MESSAGE_ID=%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x MESSAGE_ID=%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x MESSAGE_ID=%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x $ strings .libs/systemd|grep MESSAGE_ID MESSAGE_ID=c7a787079b354eaaa9e77b371893cd27 MESSAGE_ID=b07a249cd024414a82dd00cd181378ff MESSAGE_ID=641257651c1b4ec9a8624d7a40a9e1e7 MESSAGE_ID=de5b426a63be47a7b6ac3eaac82e2f6f MESSAGE_ID=d34d037fff1847e6ae669a370e694725 MESSAGE_ID=7d4958e842da4a758f6c1cdc7b36dcc5 MESSAGE_ID=1dee0369c7fc4736b7099b38ecb46ee7 MESSAGE_ID=39f53479d3a045ac8e11786248231fbf MESSAGE_ID=be02cf6855d2428ba40df7e9d022f03d MESSAGE_ID=7b05ebc668384222baa8881179cfda54 MESSAGE_ID=9d1aaa27d60140bd96365438aad20286
* man: update sd-id128(3) a bitLennart Poettering2016-10-071-15/+26
| | | | | | Let's add documentation about SD_ID128_NULL and sd_id128_is_null(). Let's also indent our examples by 8chs, as is generally our coding style.
* 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: 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.
* Reindent man pages to 2chZbigniew Jędrzejewski-Szmek2015-02-031-139/+132
|
* man: add a mapping for external manpagesZbigniew Jędrzejewski-Szmek2014-07-071-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | 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?
* man: xinclude pkg-config noteZbigniew Jędrzejewski-Szmek2014-02-201-10/+3
|
* man: fix references to .pc files which aren't separate anymoreLennart Poettering2014-02-191-2/+2
|
* man: use HTTPS links for links that support itJason St. John2013-07-161-1/+1
|
* man: improve grammar and word formatting in numerous man pagesJason St. John2013-07-021-14/+14
| | | | | | | | | | Use proper grammar, word usage, adjective hyphenation, commas, capitalization, spelling, etc. To improve readability, some run-on sentences or sentence fragments were revised. [zj: remove the space from 'file name', 'host name', and 'time zone'.]
* man: fix spacing issue in various man pagesJason St. John2013-06-291-2/+1
| | | | | | | | | | | | | Before: libsystemd-daemonpkg-config(1) After: libsystemd-daemon pkg-config(1) This fix is more complicated than it should be due to the consecutive XML elements separated by collapsible whitespace. Merging the lines and separating the XML elements with an en space or a non-breaking space is the only solution that results in one, and only one, space being inserted between them when testing. An em space results in two spaces being inserted.
* man: use <constant> for various constants which look ugly with quotesZbigniew Jędrzejewski-Szmek2013-06-261-1/+1
|
* man/sd-id128.xml: typo fixHolger Hans Peter Freyther2012-11-111-1/+1
|
* id128: introduce new SD_ID128_CONST_STR() macroLennart Poettering2012-10-161-2/+13
|
* man: Split sd_randomize(3) from sd_id128_get_{machine,boot}(3)Lennart Poettering2012-07-131-2/+4
| | | | They have too little to do with each other...
* man: move header file man pages from section 7 to 3Lennart Poettering2012-07-131-1/+1
| | | | | This way we can include documentation about minor macros/inline function within the introducionary man page in a sane way.
* man/sd-id128: Fix endian*n*essPaul Menzel2012-07-091-1/+1
| | | | | | At least Wikipedia writes it that way [1]. [1] https://en.wikipedia.org/wiki/Endianness
* man/sd-id128: Fix typos, grammar and wordingPaul Menzel2012-07-091-5/+5
| | | | • 2 was replaced by »two« in one place to avoid some ambiguity.
* man: document libsystemd-id128Lennart Poettering2012-07-061-0/+168
View Lorry Controller Status