From 30c9e12ea0d9e9d7ff1cba7ce5517e018454c146 Mon Sep 17 00:00:00 2001 From: TruongSinh Tran-Nguyen Date: Thu, 24 Oct 2024 13:57:49 -0700 Subject: [PATCH] doc/cephfs: use 'p' flag to set layouts or quotas Remind users that clients must use the 'p' flag when writing file layouts. This PR is made in response to https://www.reddit.com/r/ceph/comments/1gbad51/comment/ltkgd5v/ Co-authored-by: Zac Dover Signed-off-by: TruongSinh Tran-Nguyen (cherry picked from commit 13c7c9d99881c7b4491ba1a693283c047161ea8a) --- doc/cephfs/client-auth.rst | 2 ++ doc/cephfs/file-layouts.rst | 3 +++ 2 files changed, 5 insertions(+) diff --git a/doc/cephfs/client-auth.rst b/doc/cephfs/client-auth.rst index 0fe833441d3d5..61305e42212b5 100644 --- a/doc/cephfs/client-auth.rst +++ b/doc/cephfs/client-auth.rst @@ -106,6 +106,8 @@ If quotas are not enabled or if no quota is set on the mounted sub-directory, then the overall usage of the file system will be reported irrespective of the value of this setting. +.. _cephfs-layout-and-quota-restriction: + Layout and Quota restriction (the 'p' flag) =========================================== diff --git a/doc/cephfs/file-layouts.rst b/doc/cephfs/file-layouts.rst index 3bb6ddeae9b9c..306bbc6eb0890 100644 --- a/doc/cephfs/file-layouts.rst +++ b/doc/cephfs/file-layouts.rst @@ -6,6 +6,9 @@ File layouts The layout of a file controls how its contents are mapped to Ceph RADOS objects. You can read and write a file's layout using *virtual extended attributes* or xattrs. +Clients must use the ``p`` flag when writing a file's layout. See :ref:`Layout +and Quota restriction (the 'p' flag) `. + The name of the layout xattrs depends on whether a file is a regular file or a directory. Regular files' layout xattrs are called ``ceph.file.layout``, whereas directories' layout xattrs are called ``ceph.dir.layout``. Where subsequent examples refer to ``ceph.file.layout``, substitute ``dir`` as appropriate -- 2.39.5