From: J. Eric Ivancich <ivancich@redhat.com>
Date: Thu, 3 Apr 2025 00:23:41 +0000 (-0400)
Subject: rgw: add doc & doc testing for force option on `radosgw-admin object rm ...`
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=fb4a3989b6a56ab4c171e1edfbe4a797ed765e18;p=ceph.git

rgw: add doc & doc testing for force option on `radosgw-admin object rm ...`

Subject says it all.

Signed-off-by: J. Eric Ivancich <ivancich@redhat.com>
(cherry picked from commit 333b5cd1e36c53b69462961046199e69e906f1cc)
---

diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst
index f92a330f92e..28b34119003 100644
--- a/doc/man/8/radosgw-admin.rst
+++ b/doc/man/8/radosgw-admin.rst
@@ -135,16 +135,17 @@ as follows:
   Purge bucket index entries.
 
 :command:`object rm`
-  Remove an object.
+  Remove an S3/Swift object. Include "--yes-i-really-mean-it" to remove object's
+  entry from bucket index, for example if it's damaged.
 
 :command:`object stat`
-  Stat an object for its metadata.
+  Stat an S3/Swift object for its metadata.
 
 :command:`object unlink`
-  Unlink object from bucket index.
+  Unlink S3/Swift object from bucket index.
 
 :command:`object rewrite`
-  Rewrite the specified object.
+  Rewrite the specified S3/Swift object.
 
 :command:`objects expire`
   Run expired objects cleanup.