From: Jos Collin <jcollin@redhat.com>
Date: Wed, 30 Nov 2022 09:20:28 +0000 (+0530)
Subject: doc: updates --dump and --dumpfs
X-Git-Tag: v16.2.14~140^2~4
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=2e7d200408c4f0f1c0535c0bf62b6ea2b0f5f260;p=ceph.git

doc: updates --dump and --dumpfs

Fixes: https://tracker.ceph.com/issues/57014
Signed-off-by: Jos Collin <jcollin@redhat.com>
(cherry picked from commit 247f81e5b41fea9b1de2151e7318392c03e44c0b)
---

diff --git a/doc/cephfs/cephfs-top.rst b/doc/cephfs/cephfs-top.rst
index 857a509489d..d6fc33bc13d 100644
--- a/doc/cephfs/cephfs-top.rst
+++ b/doc/cephfs/cephfs-top.rst
@@ -80,6 +80,14 @@ By default, `cephfs-top` connects to cluster name `ceph`. To use a non-default c
 
 Interval should be greater or equal to 0.5 second. Fractional seconds are honoured.
 
+To dump the metrics to stdout without creating a curses display use::
+
+  $ cephfs-top --dump
+
+To dump the metrics of the given filesystem to stdout without creating a curses display use::
+
+  $ cephfs-top --dumpfs <fs_name>
+
 Interactive Commands
 --------------------
 
diff --git a/doc/man/8/cephfs-top.rst b/doc/man/8/cephfs-top.rst
index e20579564d2..fd18ada77ae 100644
--- a/doc/man/8/cephfs-top.rst
+++ b/doc/man/8/cephfs-top.rst
@@ -44,6 +44,14 @@ Options
 
    Refresh interval in seconds (default: 1)
 
+.. option:: --dump
+
+   Dump the metrics to stdout
+
+.. option:: --dumpfs <fs_name>
+
+   Dump the metrics of the given filesystem to stdout
+
 Descriptions of fields
 ======================