From: Matthieu Patou <mat@matws.net>
Date: Sat, 13 Oct 2012 22:02:57 +0000 (-0700)
Subject: security: Add documentation
X-Git-Tag: ldb-1.1.15~39
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7822952a11707ff8aaa415adef62082c158c2398;p=thirdparty%2Fsamba.git

security: Add documentation

Names seems to be a bit cryptic and misleading (at least for me).
So documenting them should remove at least partially this problem.

Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/libcli/security/security.h b/libcli/security/security.h
index 659d34157b0..6e4b172e66e 100644
--- a/libcli/security/security.h
+++ b/libcli/security/security.h
@@ -89,6 +89,15 @@
 #define SHARE_ALL_ACCESS      FILE_GENERIC_ALL
 #define SHARE_READ_ONLY       (FILE_GENERIC_READ|FILE_EXECUTE)
 
+/**
+ * Remaining access is a bit mask of remaining access rights (bits) that have
+ * to be granted in order to fulfill the requested access.
+ *
+ * The GUID is optional, if specified it restricts this object tree and its
+ * childs to object/attributes that inherits from this GUID.
+ * For DS access an object inherits from a GUID if one of its class has this GUID
+ * in the schemaIDGUID attribute.
+ */
 struct object_tree {
 	uint32_t remaining_access;
 	struct GUID guid;