From: J. Eric Ivancich 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-Tag: v20.3.0~152^2~1 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=333b5cd1e36c53b69462961046199e69e906f1cc;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 --- diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst index 3cd4338a5ece3..1c171dffdb52c 100644 --- a/doc/man/8/radosgw-admin.rst +++ b/doc/man/8/radosgw-admin.rst @@ -135,22 +135,23 @@ 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 manifest` - Display the manifest of RADOS objects containing the data. + Display the manifest of an S3/Swift object, producing a list of RADOS objects containing the data. :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:`object reindex` - Add an object to its bucket's index. Used rarely for emergency repairs. + Add an S3/Swift object to its bucket's index. Used rarely for emergency repairs. :command:`objects expire` Run expired objects cleanup. diff --git a/src/rgw/radosgw-admin/radosgw-admin.cc b/src/rgw/radosgw-admin/radosgw-admin.cc index 2c2b52b6a40dd..cb07211345e25 100644 --- a/src/rgw/radosgw-admin/radosgw-admin.cc +++ b/src/rgw/radosgw-admin/radosgw-admin.cc @@ -180,7 +180,7 @@ void usage() cout << " bi put store bucket index object entries\n"; cout << " bi list list raw bucket index entries\n"; cout << " bi purge purge bucket index entries\n"; - cout << " object rm remove object\n"; + cout << " object rm remove object; include --yes-i-really-mean-it to force removal from bucket index\n"; cout << " object put put object\n"; cout << " object stat stat an object for its metadata\n"; cout << " object unlink unlink object from bucket index\n"; diff --git a/src/test/cli/radosgw-admin/help.t b/src/test/cli/radosgw-admin/help.t index a5559f8fe2d37..65fb091930722 100644 --- a/src/test/cli/radosgw-admin/help.t +++ b/src/test/cli/radosgw-admin/help.t @@ -50,7 +50,7 @@ bi put store bucket index object entries bi list list raw bucket index entries bi purge purge bucket index entries - object rm remove object + object rm remove object; include --yes-i-really-mean-it to force removal from bucket index object put put object object stat stat an object for its metadata object unlink unlink object from bucket index