From b938cb902c3b5bca807a94b277672c64d6767886 Mon Sep 17 00:00:00 2001 From: Jan Engelhardt Date: Sun, 3 Aug 2014 07:11:12 +0200 Subject: doc: correct punctuation and improve typography in documentation --- man/sd_bus_error.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'man/sd_bus_error.xml') diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index 6dc4541eb1..87eac1d1b8 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -167,7 +167,7 @@ sd-bus-errors3, but additional domain-specific errors may be defined by applications. The message field usually - contains a human readable string describing the details, but might + contains a human-readable string describing the details, but might be NULL. An unset sd_bus_error structure should have both fields initialized to NULL. Set an error structure to SD_BUS_ERROR_NULL in order to @@ -189,20 +189,20 @@ for a list of well-known error names. Additional error mappings may be defined with sd_bus_error_add_map3. If - e is NULL no error structure is initialized + e is NULL, no error structure is initialized, but the error is still converted into an errno-style error. If name is NULL, it is assumed that no error occurred, and 0 is returned. This means that this function may be conveniently used in a return statement. If - message is NULL no message is set. This + message is NULL, no message is set. This call can fail if no memory may be allocated for the name and message strings, in which case an SD_BUS_ERROR_NO_MEMORY error might be set instead and -ENOMEM returned. Do not use this call on error structures that are already initialized. If you intend to reuse an - error structure free the old data stored in it with + error structure, free the old data stored in it with sd_bus_error_free() first. sd_bus_error_setf() is similar to @@ -216,8 +216,8 @@ are not copied internally, and must hence remain constant and valid for the lifetime of e. Use this call to avoid memory allocations when setting error structures. Since - this call does not allocate memory it will not fail with an - out-of-memory condition, as + this call does not allocate memory, it will not fail with an + out-of-memory condition as sd_bus_error_set() can, as described above. Alternatively, the SD_BUS_ERROR_MAKE_CONST() macro may be used @@ -249,7 +249,7 @@ format and the arguments. sd_bus_error_set_errnofv() is similar to - sd_bus_error_set_errnof() but takes the + sd_bus_error_set_errnof(), but takes the format string parameters as va_arg3 parameter list. @@ -331,7 +331,7 @@ Reference ownership sd_bus_error is not reference counted. Users should destroy resources held by it by calling - sd_bus_error_free(). Usually error structures + sd_bus_error_free(). Usually, error structures are allocated on the stack or passed in as function parameters, but they may also be allocated dynamically, in which case it is the duty of the caller to