From: Djalal Harouni <tixxdz@opendz.org>
Date: Tue, 19 Aug 2014 01:43:56 +0000 (+0100)
Subject: metadata: document creds_item_off and auxgrps_item_off fields
X-Git-Tag: upstream/0.20140911.160207utc~31
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c84e24cf82498e8b4158b7911ece2f1cd115f2b4;p=platform%2Fcore%2Fsystem%2Fkdbus-bus.git

metadata: document creds_item_off and auxgrps_item_off fields

Signed-off-by: Djalal Harouni <tixxdz@opendz.org>
---

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.