From b8bde11658366290521e3d03316378b482600323 Mon Sep 17 00:00:00 2001 From: Jan Engelhardt Date: Thu, 8 May 2014 01:28:45 +0200 Subject: doc: comma placement corrections and word order Set commas where there should be some. Some improvements to word order. --- man/sd_bus_path_encode.xml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) (limited to 'man/sd_bus_path_encode.xml') diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml index 7e11906872..5849127bed 100644 --- a/man/sd_bus_path_encode.xml +++ b/man/sd_bus_path_encode.xml @@ -82,16 +82,16 @@ along with systemd; If not, see . prefix and an external identifier string as arguments, plus a place to store the returned bus path string. The bus path prefix must be a valid bus path, starting with a slash - /, but not ending in one. The external - identifier string may be in any format, may be the empty string - and no restrictions on the charset are made - however it must + /, and not ending in one. The external + identifier string may be in any format, may be the empty string, + and has no restrictions on the charset — however, it must always be NUL-terminated. The returned string will be the concatenation of the bus path prefix plus an escaped version of the external identifier string. This operation may be reversed with sd_bus_decode(). It is - recommended to only use external identifiers here that generally + recommended to only use external identifiers that generally require little escaping to be turned into valid bus path - identifiers (for example by sticking to a 7-bit ASCII character + identifiers (for example, by sticking to a 7-bit ASCII character set), in order to ensure the resulting bus path is still short and easily processed. @@ -101,12 +101,12 @@ along with systemd; If not, see . takes a bus path and a prefix string, plus a place to store the returned external identifier string. If the bus path does not start with the specified prefix, 0 is returned and the returned - string is set to NULL. Otherwise the + string is set to NULL. Otherwise, the string following the prefix is unescaped and returned in the external identifier string. The escaping used will replace all characters which are - invalid in a bus object path by _ followed by a + invalid in a bus object path by _, followed by a hexadecimal value. As a special case, the empty string will be replaced by a lone _. @@ -118,8 +118,8 @@ along with systemd; If not, see . returns positive or 0, and a valid bus path in the return argument. On success, sd_bus_path_decode() returns a positive value if the prefixed matched, or 0 if it - did not. If the prefix matched the external identifier is returned - in the return parameter. If it did not match NULL is returned in + did not. If the prefix matched, the external identifier is returned + in the return parameter. If it did not match, NULL is returned in the return parameter. On failure, a negative errno-style error number is returned by either function. The returned strings must be -- cgit v1.2.3