X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd-id128.xml;h=3a5e13306d137f5fca56a1485d6f2092f2eb8d36;hb=a4cd87e9dce6d38846f23d44df9e21f322f946df;hp=ea4e3a4fdebb39475f3416d07d638e2c03ea08c9;hpb=40b90434832c373c1394bc502523bee39c279c24;p=elogind.git
diff --git a/man/sd-id128.xml b/man/sd-id128.xml
index ea4e3a4fd..3a5e13306 100644
--- a/man/sd-id128.xml
+++ b/man/sd-id128.xml
@@ -39,17 +39,18 @@
sd-id128
- 7
+ 3sd-id128sd_id128_tSD_ID128_MAKE
+ SD_ID128_CONST_STRSD_ID128_FORMAT_STRSD_ID128_FORMAT_VALsd_id128_equal
- APIs for processing 128 bit IDs
+ APIs for processing 128-bit IDs
@@ -67,23 +68,24 @@
Descriptionsd-id128.h provides APIs to
- process and generate 128 bit ID values. The 128 bit ID
+ process and generate 128-bit ID values. The 128-bit ID
values processed and generated by these APIs are a
generalization of OSF UUIDs as defined by RFC
- 4122, though use a simpler string
- formatting. These functions impose no structure on the
+ url="https://tools.ietf.org/html/rfc4122">RFC
+ 4122 but use a simpler string
+ format. These functions impose no structure on the
used IDs, much unlike OSF UUIDs or Microsoft GUIDs,
but are fully compatible with those types of IDs.
See
- sd_id128_to_string3 and
- sd_id128_randomize3
+ sd_id128_to_string3,
+ sd_id128_randomize3 and
+ sd_id128_get_machine3
for more information about the implemented
functions.
- A 128 bit ID is implemented as the following
+ A 128-bit ID is implemented as the following
union type:typedef union sd_id128 {
@@ -91,26 +93,36 @@
uint64_t qwords[2];
} sd_id128_t;
- This union type allows accessing the 128 bit ID
- as 16 separate bytes or two 64 bit words. It is generally
- safer to access the ID components by their 8 bit array
+ This union type allows accessing the 128-bit ID
+ 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 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.A couple of macros are defined to denote and
- decode 128 bit IDs:
+ decode 128-bit IDs:SD_ID128_MAKE() 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:
+ 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:#define SD_MESSAGE_COREDUMP SD_ID128_MAKE(fc,2e,22,bc,6e,e6,47,b6,b9,07,29,ab,34,a2,50,b1)
+ SD_ID128_CONST_STR() may be
+ used to convert constant 128-bit IDs into constant
+ strings for output. The following example code will
+ output the string
+ "fc2e22bc6ee647b6b90729ab34a250b1":
+ int main(int argc, char *argv[]) {
+ puts(SD_ID128_CONST_STR(SD_MESSAGE_COREDUMP));
+}
+
SD_ID128_FORMAT_STR and
SD_ID128_FORMAT_VAL() may be used
- to format a 128 bit ID in a
+ to format a 128-bit ID in a
printf3
format string, as shown in the following
example:
@@ -122,7 +134,7 @@
return 0;
}
- Use sd_id128_equal() to compare two 128 bit IDs:
+ Use sd_id128_equal() to compare two 128-bit IDs:int main(int argc, char *argv[]) {
sd_id128_t a, b, c;
@@ -137,7 +149,7 @@
Note that new, randomized IDs may be generated
with
journalctl1's
- --new-id option.
+ option.
@@ -145,8 +157,7 @@
These APIs are implemented as a shared library,
which can be compiled and linked to with the
- libsystemd-id128
- pkg-config1
+ libsystemd-id128Â pkg-config1
file.
@@ -157,6 +168,7 @@
systemd1,
sd_id128_to_string3,
sd_id128_randomize3,
+ sd_id128_get_machine3,
printf3,
journalctl1,
sd-journal7,