doc: Document that client_dirsize_rbytes confuses rsync

This is important to document because otherwise the immediate question
one has is "why _wouldn't_ I enable this?".
At the same time, being able to use tools like rsync is a common
motivation for using CephFS.

Unfortunately the only source to this I could find is the presentation
"CephFS: Architecture Introduction & New Features" by Greg Farnum:
https://ceph.io/assets/pdfs/events/2025/ceph-days-silicon-valley/10%20-%20Greg%20-%20CephFS.pdf

Signed-off-by: Niklas Hambüchen <mail@nh2.me>

diff --git a/doc/man/8/mount.ceph.rst b/doc/man/8/mount.ceph.rst
index 6e960594fdd1a06c564461fb0e0a6ddb52f0b518..ba4d0bb918c3fc658bbcb2c6368b9c145483782a 100644 (file)
--- a/doc/man/8/mount.ceph.rst
+++ b/doc/man/8/mount.ceph.rst
@@ -165,7 +165,7 @@ Advanced
 
 :command:`rbytes`
     Report the recursive size of the directory contents for st_size on
-    directories.  Default: off
+    directories. May confuse programs such as rsync.  Default: off
 
 :command:`norbytes`
     Do not report the recursive size of the directory contents for

diff --git a/src/common/options/mds-client.yaml.in b/src/common/options/mds-client.yaml.in
index 3603c67393ea40b5faade9fca84a86b3b3ab18c8..2e7ee29bc3bd21b74ee329ff441e5104d808b213 100644 (file)
--- a/src/common/options/mds-client.yaml.in
+++ b/src/common/options/mds-client.yaml.in
@@ -320,7 +320,7 @@ options:
   desc: set the directory size as the number of file bytes recursively used
   long_desc: This option enables a CephFS feature that stores the recursive directory
     size (the bytes used by files in the directory and its descendents) in the st_size
-    field of the stat structure.
+    field of the stat structure. May confuse programs such as ``rsync``.
   default: true
   services:
   - mds_client