diff options
| author | Jason St. John <jstjohn@purdue.edu> | 2013-06-27 21:51:44 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2013-07-02 23:06:22 -0400 |
| commit | e9dd9f9547350c7dc0473583b5c2228dc8f0ab76 (patch) | |
| tree | 8c40d1a1e527a09974839ac44a3b7b3d19232758 /man/sd_id128_to_string.xml | |
| parent | 6824690f140f45064157d220a24b9afbeb1d093f (diff) | |
man: improve grammar and word formatting in numerous man pages
Use proper grammar, word usage, adjective hyphenation, commas,
capitalization, spelling, etc.
To improve readability, some run-on sentences or sentence fragments were
revised.
[zj: remove the space from 'file name', 'host name', and 'time zone'.]
Diffstat (limited to 'man/sd_id128_to_string.xml')
| -rw-r--r-- | man/sd_id128_to_string.xml | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index 6d5cf45f90..3da5b70f80 100644 --- a/man/sd_id128_to_string.xml +++ b/man/sd_id128_to_string.xml @@ -45,7 +45,7 @@ <refnamediv> <refname>sd_id128_to_string</refname> <refname>sd_id128_from_string</refname> - <refpurpose>Format or parse 128 bit IDs as strings</refpurpose> + <refpurpose>Format or parse 128-bit IDs as strings</refpurpose> </refnamediv> <refsynopsisdiv> @@ -69,7 +69,7 @@ <title>Description</title> <para><function>sd_id128_to_string()</function> - 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 @@ -78,10 +78,10 @@ <para><function>sd_id128_from_string()</function> 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 + (either lowercase or uppercase, terminated by NUL) and + parses them back into a 128-bit ID returned in <parameter>ret</parameter>. 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.</para> <para>For more information about the @@ -89,9 +89,9 @@ <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Note that these calls operate the same way on all architectures, i.e. the results do not depend on - endianess.</para> + endianness.</para> - <para>When formatting a 128 bit ID into a string it is + <para>When formatting a 128-bit ID into a string, it is often easier to use a format string for <citerefentry><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This is easily done using the @@ -106,9 +106,9 @@ <para><function>sd_id128_to_string()</function> always succeeds and returns a pointer to the string array - passed in. <function>sd_id128_from_string</function> - returns 0 on success (in which case - <parameter>ret</parameter> is filled in), or a negative + passed in. <function>sd_id128_from_string</function> + returns 0 on success, in which case + <parameter>ret</parameter> is filled in, or a negative errno-style error code.</para> </refsect1> |