rgw: Add documentation for the --pretty-format option

Fixes: http://tracker.ceph.com/issues/75988
Signed-off-by: Nathan Hoad <nhoad@bloomberg.net>

diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst
index 163dcc89e0d8811e49cb7b4a4982f84434b5c03a..57826dfd900a3de7baaa605aa362248706b95982 100644 (file)
--- a/doc/man/8/radosgw-admin.rst
+++ b/doc/man/8/radosgw-admin.rst
@@ -820,6 +820,12 @@ Options
 
     Specify output format for certain operations. Supported formats: xml, json.
 
+.. option:: --pretty-format
+
+    Enable pretty formatting for JSON/XML output with indentation and newlines.
+    If no format is specified, default is true. Use ``--format <json/xml>`` to disable
+    for more compact output.
+
 .. option:: --sync-stats
 
     Option for the 'user stats' command. When specified, it will update user stats with

diff --git a/src/rgw/radosgw-admin/radosgw-admin.cc b/src/rgw/radosgw-admin/radosgw-admin.cc
index 4e2c39d6a9cf5452192b070bdc5750e271511f6f..f8986f49f7fd5594173d804e0d86d19338a327cd 100644 (file)
--- a/src/rgw/radosgw-admin/radosgw-admin.cc
+++ b/src/rgw/radosgw-admin/radosgw-admin.cc
@@ -459,7 +459,8 @@ void usage()
   cout << "   --bucket-index-max-shards         override a zone/zonegroup's default bucket index shard count\n";
   cout << "   --fix                             besides checking bucket index, will also fix it\n";
   cout << "   --check-objects                   bucket check: rebuilds bucket index according to actual objects state\n";
-  cout << "   --format=<format>                 specify output format for certain operations: xml, json\n";
+  cout << "   --format=<format>                 specify output format for certain operations: xml, json (default: json)\n";
+  cout << "   --pretty-format                   enable pretty formatting for json/xml output\n";
   cout << "   --purge-data                      when specified, user removal will also purge all the\n";
   cout << "                                     user data\n";
   cout << "   --purge-keys                      when specified, subuser removal will also purge all the\n";

diff --git a/src/test/cli/radosgw-admin/help.t b/src/test/cli/radosgw-admin/help.t
index fb68f164e344ca7695887a50b5eeeaed605f4c0d..f6744bb216b7b416d3ad0c76e8f6a5e4e948f4db 100644 (file)
--- a/src/test/cli/radosgw-admin/help.t
+++ b/src/test/cli/radosgw-admin/help.t
@@ -319,7 +319,8 @@
      --bucket-index-max-shards         override a zone/zonegroup's default bucket index shard count
      --fix                             besides checking bucket index, will also fix it
      --check-objects                   bucket check: rebuilds bucket index according to actual objects state
-     --format=<format>                 specify output format for certain operations: xml, json
+     --format=<format>                 specify output format for certain operations: xml, json (default: json)
+     --pretty-format                   enable pretty formatting for json/xml output
      --purge-data                      when specified, user removal will also purge all the
                                        user data
      --purge-keys                      when specified, subuser removal will also purge all the