From: Ken Dreyer <kdreyer@redhat.com>
Date: Thu, 4 Feb 2016 02:51:58 +0000 (-0700)
Subject: doc: add orphans commands to radosgw-admin(8)
X-Git-Tag: v0.94.6~2^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F7524%2Fhead;p=ceph.git

doc: add orphans commands to radosgw-admin(8)

The --help text was added in 105a76bf542e05b739d5a03ca8ae55432350f107.
Add the corresponding entries to the man page.

Fixes: #14637

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>

(cherry picked from commit ec162f068b40f594c321df5caa9fe2541551b89e)
  Cherry-pick to hammer includes nroff source change (in master the
  nroff sources are no longer present in Git.)
---

diff --git a/doc/man/8/radosgw-admin.rst b/doc/man/8/radosgw-admin.rst
index cae8b81a6750..2e43c192477d 100644
--- a/doc/man/8/radosgw-admin.rst
+++ b/doc/man/8/radosgw-admin.rst
@@ -83,6 +83,12 @@ Commands
 :command:`usage trim`
   Trim usage information (with optional user and date range)
 
+:command:`orphans find`
+  Init and run search for leaked rados objects
+
+:command:`orphans finish`
+  Clean up search for leaked rados objects
+
 
 Options
 =======
@@ -150,6 +156,18 @@ Options
    Defer removal of object tail
    
 
+Orphans Search Options
+======================
+
+.. option:: --pool
+
+	Data pool to scan for leaked rados objects
+
+.. option:: --num-shards
+
+	Number of shards to use for keeping the temporary scan info
+
+
 Examples
 ========
 
diff --git a/man/radosgw-admin.8 b/man/radosgw-admin.8
index 760c67526e68..7b830903191e 100644
--- a/man/radosgw-admin.8
+++ b/man/radosgw-admin.8
@@ -131,6 +131,12 @@ Show the usage information (with optional user and date range)
 .TP
 .B \fBusage trim\fP
 Trim usage information (with optional user and date range)
+.TP
+.B \fBorphans find\fP
+Init and run search for leaked rados objects
+.TP
+.B \fBorphans finish\fP
+Clean up search for leaked rados objects
 .UNINDENT
 .SH OPTIONS
 .INDENT 0.0
@@ -210,6 +216,17 @@ Remove all objects before bucket removal
 .B \-\-lazy\-remove
 Defer removal of object tail
 .UNINDENT
+.SH ORPHANS SEARCH OPTIONS
+.INDENT 0.0
+.TP
+.B \-\-pool
+Data pool to scan for leaked rados objects
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-num\-shards
+Number of shards to use for keeping the temporary scan info
+.UNINDENT
 .SH EXAMPLES
 .sp
 Generate a new user: