From: J. Eric Ivancich <ivancich@redhat.com>
Date: Mon, 16 Aug 2021 22:28:07 +0000 (-0400)
Subject: doc: clarify use of `rados rm` command
X-Git-Tag: v17.1.0~1090^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=8e975ba9fda04f8bbb8fc1aea1f916852b6cb59b;p=ceph.git

doc: clarify use of `rados rm` command

The man page did not make it clear that multiple objects could be
specified, nor did it describe use of "--force-full".

Info displayed about "rm" with `rados --help` was poorly formatted and
the wording was adjusted.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
---

diff --git a/doc/man/8/rados.rst b/doc/man/8/rados.rst
index 5e6e76b070e..d606c3a5ef5 100644
--- a/doc/man/8/rados.rst
+++ b/doc/man/8/rados.rst
@@ -264,8 +264,8 @@ Pool specific commands
 :command:`append` *name* *infile*
   Append object name to the cluster with contents from infile.
 
-:command:`rm` *name*
-  Remove object name.
+:command:`rm` [--force-full] *name* ...
+  Remove object(s) with name(s). With ``--force-full`` will remove when cluster is marked full.
 
 :command:`listwatchers` *name*
   List the watchers of object name.
diff --git a/src/tools/rados/rados.cc b/src/tools/rados/rados.cc
index 75a7ad07c43..6cb1d0d180e 100644
--- a/src/tools/rados/rados.cc
+++ b/src/tools/rados/rados.cc
@@ -107,7 +107,7 @@ void usage(ostream& out)
 "   append <obj-name> <infile>       append object\n"
 "   truncate <obj-name> length       truncate object\n"
 "   create <obj-name>                create object\n"
-"   rm <obj-name> ...[--force-full]  [force no matter full or not]remove object(s)\n"
+"   rm <obj-name> ... [--force-full] remove object(s), --force-full forces remove when cluster is full\n"
 "   cp <obj-name> [target-obj]       copy object\n"
 "   listxattr <obj-name>             list attrs of this object\n"
 "   getxattr <obj-name> <attr>       get the <attr> attribute of this object\n"