X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsd_id128_to_string.xml;h=62badda8e244181ae9ba2731b438cd17fec0ea42;hb=b9d394ea565fd742bcdd34e8dd61ae07c58a9565;hp=3a171550e987b3c515d24aa08fbd4d513a5c97dd;hpb=12355095821fc17529af5b6eaefa31c3c520be39;p=elogind.git
diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml
index 3a171550e..62badda8e 100644
--- a/man/sd_id128_to_string.xml
+++ b/man/sd_id128_to_string.xml
@@ -45,7 +45,7 @@
sd_id128_to_string
sd_id128_from_string
- Format or parse 128 bit IDs as strings
+ Format or parse 128-bit IDs as strings
@@ -53,13 +53,13 @@
#include <systemd/sd-id128.h>
- char* sd_id128_to_string
+ char *sd_id128_to_string
sd_id128_t id, char s[33]
int sd_id128_from_string
- const char s[33], sd_id128_t* ret
+ const char *s, sd_id128_t *ret
@@ -69,31 +69,37 @@
Description
sd_id128_to_string()
- formats a 128 bit ID as character string. It expects
+ formats a 128-bit ID as a character string. It expects
the ID and a string array capable of storing 33
characters. The ID will be formatted as 32 lowercase
- hexadecimal digits and be terminated by a NUL
- byte.
+ hexadecimal digits and be terminated by a
+ NUL byte.
sd_id128_from_string()
implements the reverse operation: it takes a 33
- character array with 32 hexadecimial digits
- (terminated by NUL) and parses them back into an
- 128 bit ID returned in
- ret.
+ character string with 32 hexadecimal digits (either
+ lowercase or uppercase, terminated by
+ NUL) and parses them back into a
+ 128-bit ID returned in
+ ret. Alternatively, this call
+ can also parse a 37-character string with a 128-bit ID
+ formatted as RFC UUID.
For more information about the
sd_id128_t type see
- sd-id1287.
+ sd-id1283. Note
+ that these calls operate the same way on all
+ architectures, i.e. the results do not depend on
+ endianness.
- When formatting a 128 bit ID into a string it is
+ When formatting a 128-bit ID into a string, it is
often easier to use a format string for
- printf3. This
- is easly done using the
+ printf3. This
+ is easily done using the
SD_ID128_FORMAT_STR and
SD_ID128_FORMAT_VAL() macros. For
more information see
- sd-id1287.
+ sd-id1283.
@@ -101,9 +107,9 @@
sd_id128_to_string() always
succeeds and returns a pointer to the string array
- passed in. sd_id128_from_string
- returns 0 on success (in which case
- ret is filled in), or a negative
+ passed in. sd_id128_from_string
+ returns 0 on success, in which case
+ ret is filled in, or a negative
errno-style error code.
@@ -112,9 +118,8 @@
The sd_id128_to_string()
and sd_id128_from_string() interfaces are
- available as shared library, which can be compiled and
- linked to with the libsystemd-id128
- pkg-config1
+ available as a shared library, which can be compiled and
+ linked to with the libsystemd pkg-config1
file.
@@ -123,8 +128,8 @@
systemd1,
- sd-id1287,
- printf3
+ sd-id1283,
+ printf3