[systemd-devel] [PATCH 1/3] metadata: document creds_item_off and auxgrps_item_off fields

[Daniel Mack]

On 08/19/2014 03:43 AM, Djalal Harouni wrote:
> Signed-off-by: Djalal Harouni <tixxdz at opendz.org>
> ---
>  metadata.c | 3 ++-
>  metadata.h | 8 +++++++-
>  2 files changed, 9 insertions(+), 2 deletions(-)

Applied, thanks!

> 
> diff --git a/metadata.c b/metadata.c
> index eb286aa..3dff9ac 100644
> --- a/metadata.c
> +++ b/metadata.c
> @@ -130,7 +130,8 @@ kdbus_meta_append_item(struct kdbus_meta *meta, u64 type, size_t payload_size)
>   * kdbus_meta_append_data() - append given raw data to metadata object
>   * @meta:		Metadata object
>   * @type:		KDBUS_ITEM_* type
> - * @data:		pointer to data to copy from
> + * @data:		pointer to data to copy from. If it is NULL
> + *			then just make space in the metadata buffer.
>   * @len:		number of bytes to copy
>   *
>   * Return: 0 on success, negative errno on failure.
> diff --git a/metadata.h b/metadata.h
> index a142aea..1bdb537 100644
> --- a/metadata.h
> +++ b/metadata.h
> @@ -16,10 +16,16 @@
>  /**
>   * struct kdbus_meta - metadata buffer
>   * @attached:		Flags for already attached data
> - * @domain:			Domain the metadata belongs to
> + * @domain:		Domain the metadata belongs to
>   * @data:		Allocated buffer
>   * @size:		Number of bytes used
>   * @allocated_size:	Size of buffer
> + * @creds_item_off	The offset of the creds item in the @data
> + *			buffer field, if the user requested this
> + *			metainfo in its attach flags. 0 if unused.
> + * @auxgrps_item_off	The offset of the auxgroups item in the
> + *			@data buffer field, if the user requested
> + *			this metainfo. 0 if unused.
>   *
>   * Used to collect and store connection metadata in a pre-compiled
>   * buffer containing struct kdbus_item.
>