chiark
/
gitweb
/
~ianmdlvl
/
elogind.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
test: use non-blocking systemctl calls in testsuite.service
[elogind.git]
/
man
/
sd-id128.xml
diff --git
a/man/sd-id128.xml
b/man/sd-id128.xml
index cbc130d7513578326a173a41abcc8eca3bbc3b06..ac2000e275c53253645e45cb19f624437ee569ac 100644
(file)
--- a/
man/sd-id128.xml
+++ b/
man/sd-id128.xml
@@
-39,13
+39,14
@@
<refmeta>
<refentrytitle>sd-id128</refentrytitle>
<refmeta>
<refentrytitle>sd-id128</refentrytitle>
- <manvolnum>
7
</manvolnum>
+ <manvolnum>
3
</manvolnum>
</refmeta>
<refnamediv>
<refname>sd-id128</refname>
<refname>sd_id128_t</refname>
<refname>SD_ID128_MAKE</refname>
</refmeta>
<refnamediv>
<refname>sd-id128</refname>
<refname>sd_id128_t</refname>
<refname>SD_ID128_MAKE</refname>
+ <refname>SD_ID128_CONST_STR</refname>
<refname>SD_ID128_FORMAT_STR</refname>
<refname>SD_ID128_FORMAT_VAL</refname>
<refname>sd_id128_equal</refname>
<refname>SD_ID128_FORMAT_STR</refname>
<refname>SD_ID128_FORMAT_VAL</refname>
<refname>sd_id128_equal</refname>
@@
-78,10
+79,11
@@
</para>
<para>See
</para>
<para>See
- <citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
- <citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- for more information about the functions
- implemented.</para>
+ <citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
+ <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>
+ for more information about the implemented
+ functions.</para>
<para>A 128 bit ID is implemented as the following
union type:</para>
<para>A 128 bit ID is implemented as the following
union type:</para>
@@
-92,9
+94,9
@@
} sd_id128_t;</programlisting>
<para>This union type allows accessing the 128 bit ID
} sd_id128_t;</programlisting>
<para>This union type allows accessing the 128 bit ID
- as 16 separate bytes or
2
64 bit words. It is generally
+ as 16 separate bytes or
two
64 bit words. It is generally
safer to access the ID components by their 8 bit array
safer to access the ID components by their 8 bit array
- to avoid endianess issues. This union is intended to
+ to avoid endian
n
ess issues. This union is intended to
be passed call-by-value (as opposed to
call-by-reference) and may be directly manipulated by
clients.</para>
be passed call-by-value (as opposed to
call-by-reference) and may be directly manipulated by
clients.</para>
@@
-103,11
+105,21
@@
decode 128 bit IDs:</para>
<para><function>SD_ID128_MAKE()</function> may be used
decode 128 bit IDs:</para>
<para><function>SD_ID128_MAKE()</function> may be used
- to write a 128 bit ID in source code. A commonly used
- idiom is to give 128 bit IDs names using this macro:</para>
+ to denote a constant 128 bit ID in source code. A
+ commonly used idiom is to assign a name to a 128 bit
+ ID using this macro:</para>
<programlisting>#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)</programlisting>
<programlisting>#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)</programlisting>
+ <para><function>SD_ID128_CONST_STR()</function> may be
+ used to convert constant 128bit IDs into constant
+ strings for output. The following example code will
+ output the string
+ "fc2e22bc6ee647b6b90729ab34a250b1":</para>
+ <programlisting>int main(int argc, char *argv[]) {
+ puts(SD_ID128_CONST_STR(SD_MESSAGE_COREDUMP));
+}</programlisting>
+
<para><function>SD_ID128_FORMAT_STR</function> and
<function>SD_ID128_FORMAT_VAL()</function> may be used
to format a 128 bit ID in a
<para><function>SD_ID128_FORMAT_STR</function> and
<function>SD_ID128_FORMAT_VAL()</function> may be used
to format a 128 bit ID in a
@@
-137,13
+149,13
@@
<para>Note that new, randomized IDs may be generated
with
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
<para>Note that new, randomized IDs may be generated
with
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s
- <literal>--new-id</literal>
command
.</para>
+ <literal>--new-id</literal>
option
.</para>
</refsect1>
<refsect1>
<title>Notes</title>
</refsect1>
<refsect1>
<title>Notes</title>
- <para>These APIs are implemented as shared library,
+ <para>These APIs are implemented as
a
shared library,
which can be compiled and linked to with the
<literal>libsystemd-id128</literal>
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
which can be compiled and linked to with the
<literal>libsystemd-id128</literal>
<citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
@@
-157,6
+169,7
@@
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
<citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>7</manvolnum></citerefentry>,