From: John Spray <john.spray@redhat.com>
Date: Fri, 27 Nov 2015 12:28:35 +0000 (+0000)
Subject: mds: add docstring for MDSAuthCaps::path_capable
X-Git-Tag: v10.0.3~48^2~4^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=94ee1ead0ae8949f67afe832bc3ddb7ae26f0070;p=ceph.git

mds: add docstring for MDSAuthCaps::path_capable

Signed-off-by: John Spray <john.spray@redhat.com>
---

diff --git a/src/mds/MDSAuthCaps.h b/src/mds/MDSAuthCaps.h
index 0ecf8ac4a0a..ccf2857b70b 100644
--- a/src/mds/MDSAuthCaps.h
+++ b/src/mds/MDSAuthCaps.h
@@ -95,6 +95,12 @@ struct MDSCapMatch {
 	     const int caller_uid,
 	     const int caller_gid) const;
 
+  /**
+   * Check whether this path *might* be accessible (actual permission
+   * depends on the stronger check in match()).
+   *
+   * @param target_path filesystem path without leading '/'
+   */
   bool match_path(const std::string &target_path) const;
 };