X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd-id128.xml;h=abd2004d1caeb244d1554f48c9fd34cbf12f8db0;hp=cbc130d7513578326a173a41abcc8eca3bbc3b06;hb=5de0409e54580b1e8929d9e09f970dfe339cec7b;hpb=12355095821fc17529af5b6eaefa31c3c520be39

diff --git a/man/sd-id128.xml b/man/sd-id128.xml
index cbc130d75..abd2004d1 100644
--- a/man/sd-id128.xml
+++ b/man/sd-id128.xml
@@ -39,13 +39,14 @@
 
         <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>
+                <refname>SD_ID128_CONST_STR</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
-                <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>
@@ -92,9 +94,9 @@
 } 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
-                to avoid endianess issues. This union is intended to
+                to avoid endianness 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>
@@ -103,11 +105,21 @@
                 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>
 
+                <para><function>SD_ID128_CONST_STR()</function> may be
+                use 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
@@ -137,13 +149,13 @@
                 <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>
 
-                <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>
@@ -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>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>,