From: Lennart Poettering Date: Tue, 28 Jan 2020 15:28:04 +0000 (+0100) Subject: man: enclose C type names in X-Git-Tag: v245-rc1~66^2~3 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=979bdc47c9cda3960009525d4a870419f04bfc5d;p=thirdparty%2Fsystemd.git man: enclose C type names in --- diff --git a/man/sd_bus_message_read.xml b/man/sd_bus_message_read.xml index 526fb0e70af..aa3cffb4326 100644 --- a/man/sd_bus_message_read.xml +++ b/man/sd_bus_message_read.xml @@ -60,13 +60,13 @@ For each type specified in the type string, one or more arguments need to be specified after the types parameter, in the same order. The arguments must be - pointers to appropriate types (a pointer to int8_t for a y in - the type string, a pointer to int32_t for an i, a pointer to - const char* for an s, ...) which are set based on the values in + pointers to appropriate types (a pointer to int8_t for a y in + the type string, a pointer to int32_t for an i, a pointer to + const char* for an s, ...) which are set based on the values in the message. As an exception, in case or array and variant types, the first argument is an "input" argument that further specifies how the message should be read. See the table below for a complete list of allowed arguments and their types. Note that, if the basic type is a pointer - (e.g., const char * in the case of a string), the argument is a pointer to a + (e.g., const char * in the case of a string), the argument is a pointer to a pointer, and also the pointer value that is written is only borrowed and the contents must be copied if they are to be used after the end of the messages lifetime. @@ -99,7 +99,7 @@ a SD_BUS_TYPE_ARRAY array - int, which specifies the expected length n of the array + int, which specifies the expected length n of the array n sets of arguments appropriate for the array element type diff --git a/man/sd_bus_message_read_basic.xml b/man/sd_bus_message_read_basic.xml index 101f5d21a49..b753253f184 100644 --- a/man/sd_bus_message_read_basic.xml +++ b/man/sd_bus_message_read_basic.xml @@ -55,10 +55,10 @@ If p is not NULL, it should contain a pointer to an appropriate object. For example, if type is 'y', the object passed in p - should have type uint8_t *. If type is + should have type uint8_t *. If type is 's', the object passed in p should - have type const char **. Note that, if the basic type is a pointer - (e.g., const char * in the case of a string), the pointer is only + have type const char **. Note that, if the basic type is a pointer + (e.g., const char * in the case of a string), the pointer is only borrowed and the contents must be copied if they are to be used after the end of the messages lifetime. Similarly, during the lifetime of such a pointer, the message must not be modified. See the table below for a complete list of allowed @@ -86,91 +86,91 @@ y SD_BUS_TYPE_BYTE unsigned integer - uint8_t * + uint8_t * b SD_BUS_TYPE_BOOLEAN boolean - int * + int * n SD_BUS_TYPE_INT16 signed integer - int16_t * + int16_t * q SD_BUS_TYPE_UINT16 unsigned integer - uint16_t * + uint16_t * i SD_BUS_TYPE_INT32 signed integer - int32_t * + int32_t * u SD_BUS_TYPE_UINT32 unsigned integer - uint32_t * + uint32_t * x SD_BUS_TYPE_INT64 signed integer - int64_t * + int64_t * t SD_BUS_TYPE_UINT64 unsigned integer - uint64_t * + uint64_t * d SD_BUS_TYPE_DOUBLE floating-point - double * + double * s SD_BUS_TYPE_STRING Unicode string - const char ** + const char ** o SD_BUS_TYPE_OBJECT_PATH object path - const char ** + const char ** g SD_BUS_TYPE_SIGNATURE signature - const char ** + const char ** h SD_BUS_TYPE_UNIX_FD UNIX file descriptor - int * + int *