From: Laura Flores <lflores@redhat.com>
Date: Wed, 6 Apr 2022 16:53:44 +0000 (-0500)
Subject: doc/man/8: update the description of `--format`
X-Git-Tag: v17.2.1~49^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=195e3f125d1faef66117f32d8f9c4b452e1ee415;p=ceph.git

doc/man/8: update the description of `--format`

The `ceph --format` option includes yaml, which
is only valid for orch commands.

Signed-off-by: Laura Flores <lflores@redhat.com>
(cherry picked from commit e23b53833f32d1ac5c8ae64c8797d117e4141278)
---

diff --git a/doc/man/8/ceph.rst b/doc/man/8/ceph.rst
index 639d85e565d6f..77ecd1fab7629 100644
--- a/doc/man/8/ceph.rst
+++ b/doc/man/8/ceph.rst
@@ -1615,9 +1615,9 @@ Options
 
 	Make less verbose.
 
-.. option:: -f {json,json-pretty,xml,xml-pretty,plain}, --format
+.. option:: -f {json,json-pretty,xml,xml-pretty,plain,yaml}, --format
 
-	Format of output.
+	Format of output. Note: yaml is only valid for orch commands. 
 
 .. option:: --connect-timeout CLUSTER_TIMEOUT