From: John Spray Date: Fri, 4 Nov 2016 10:05:57 +0000 (+0000) Subject: cephfs/capabilities: fix rst syntax X-Git-Tag: v11.1.0~419^2~3 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=e33355d228d2aaf211e9e769fdd91009492f06b9;p=ceph.git cephfs/capabilities: fix rst syntax Although we don't link this into built docs, it generates warnings during build. Signed-off-by: John Spray --- diff --git a/doc/cephfs/capabilities.rst b/doc/cephfs/capabilities.rst index e119806efae3..7cd27162ff06 100644 --- a/doc/cephfs/capabilities.rst +++ b/doc/cephfs/capabilities.rst @@ -14,6 +14,7 @@ There are several "generic" capability bits. These denote what sort of ability the capability grants. :: + /* generic cap bits */ #define CEPH_CAP_GSHARED 1 /* client can reads (s) */ #define CEPH_CAP_GEXCL 2 /* client can read and update (x) */ @@ -28,6 +29,7 @@ These are then shifted by a particular number of bits. These denote a part of the inode's data or metadata on which the capability is being granted: :: + /* per-lock shift */ #define CEPH_CAP_SAUTH 2 /* A */ #define CEPH_CAP_SLINK 4 /* L */ @@ -39,6 +41,7 @@ however. In particular, only the FILE shift ever has more than the first two bits. :: + | AUTH | LINK | XATTR | FILE 2 4 6 8 @@ -46,6 +49,7 @@ From the above, we get a number of constants, that are generated by taking each bit value and shifting to the correct bit in the word: :: + #define CEPH_CAP_AUTH_SHARED (CEPH_CAP_GSHARED << CEPH_CAP_SAUTH) These bits can then be or'ed together to make a bitmask denoting a set of @@ -54,6 +58,7 @@ capabilities. There is one exception: :: + #define CEPH_CAP_PIN 1 /* no specific capabilities beyond the pin */ The "pin" just pins the inode into memory, without granting any other caps. @@ -61,6 +66,7 @@ The "pin" just pins the inode into memory, without granting any other caps. Graphically: :: + +---+---+---+---+---+---+---+---+ | p | _ |As x |Ls x |Xs x | +---+---+---+---+---+---+---+---+