X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsd_id128_to_string.xml;h=eae291578a50026cece1028c5669e8126f468b6d;hp=6d5cf45f90a224337813338a6a181787db3ba587;hb=4cd1214db6cf4b262e8ce6381bc710091b375c96;hpb=1e158d273bb63883566358cbb886cd4167421df6 diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index 6d5cf45f9..eae291578 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 @@ -69,19 +69,20 @@ 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 string with 32 hexadecimal digits - (either lowercase or uppercase, terminated by NUL) and parses them back into an 128 - bit ID returned in + 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 128bit ID + can also parse a 37-character string with a 128-bit ID formatted as RFC UUID. For more information about the @@ -89,9 +90,9 @@ sd-id1283. Note that these calls operate the same way on all architectures, i.e. the results do not depend on - endianess. + 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 easily done using the @@ -106,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. @@ -117,7 +118,7 @@ The sd_id128_to_string() and sd_id128_from_string() interfaces are - available as shared library, which can be compiled and + available as a shared library, which can be compiled and linked to with the libsystemd-id128 pkg-config1 file.