From 8e975ba9fda04f8bbb8fc1aea1f916852b6cb59b Mon Sep 17 00:00:00 2001 From: "J. Eric Ivancich" Date: Mon, 16 Aug 2021 18:28:07 -0400 Subject: [PATCH] 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 --- doc/man/8/rados.rst | 4 ++-- src/tools/rados/rados.cc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/man/8/rados.rst b/doc/man/8/rados.rst index 5e6e76b070e6e..d606c3a5ef58e 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 75a7ad07c43dd..6cb1d0d180ed4 100644 --- a/src/tools/rados/rados.cc +++ b/src/tools/rados/rados.cc @@ -107,7 +107,7 @@ void usage(ostream& out) " append append object\n" " truncate length truncate object\n" " create create object\n" -" rm ...[--force-full] [force no matter full or not]remove object(s)\n" +" rm ... [--force-full] remove object(s), --force-full forces remove when cluster is full\n" " cp [target-obj] copy object\n" " listxattr list attrs of this object\n" " getxattr get the attribute of this object\n" -- 2.39.5