rbd-replay: Add man page and package binaries for rbd-replay-prep

Signed-off-by: Adam Crume <adamcrume@gmail.com>

diff --git a/ceph.spec.in b/ceph.spec.in
index f8d2d92041d3aa6252f2f95d45f5119d6617c22a..b985511775ec27eef8b161f68bee1d9820517c7d 100644 (file)
--- a/ceph.spec.in
+++ b/ceph.spec.in
@@ -721,7 +721,9 @@ ln -sf %{_libdir}/librbd.so.1 /usr/lib64/qemu/librbd.so.1
 %{_bindir}/ceph-osdomap-tool
 %{_bindir}/ceph-kvstore-tool
 %{_mandir}/man8/rbd-replay.8*
+%{_mandir}/man8/rbd-replay-prep.8*
 %{_bindir}/rbd-replay
+%{_bindir}/rbd-replay-prep
 
 %files -n libcephfs_jni1
 %defattr(-,root,root,-)

diff --git a/debian/ceph-test.install b/debian/ceph-test.install
index 18e181711b0fe573d0ece2df3578640ba63096c5..58c7f362e3133d5d22939cfa2c2b10010ab9e5ce 100644 (file)
--- a/debian/ceph-test.install
+++ b/debian/ceph-test.install
@@ -27,4 +27,6 @@ usr/bin/ceph-osdomap-tool
 usr/bin/ceph-kvstore-tool
 usr/share/java/libcephfs-test.jar
 usr/bin/rbd-replay
+usr/bin/rbd-replay-prep
 usr/share/man/man8/rbd-replay.8
+usr/share/man/man8/rbd-replay-prep.8

diff --git a/doc/man/8/rbd-replay-prep.rst b/doc/man/8/rbd-replay-prep.rst
new file mode 100644 (file)
index 0000000..9bc93be
--- /dev/null
+++ b/doc/man/8/rbd-replay-prep.rst
@@ -0,0 +1,46 @@
+====================================================================================
+ rbd-replay-prep -- prepare captured rados block device (RBD) workloads for replay
+====================================================================================
+
+.. program:: rbd-replay-prep
+
+Synopsis
+========
+
+| **rbd-replay-prep** [ --window *seconds* ] *trace_dir* *replay_file*
+
+
+Description
+===========
+
+**rbd-replay-prep** processes raw rados block device (RBD) traces to prepare them for **rbd-replay**.
+
+
+Options
+=======
+
+.. option:: --window seconds
+
+   Requests further apart than 'seconds' seconds are assumed to be independent.
+
+
+Examples
+========
+
+To prepare workload1-trace for replay::
+
+       rbd-replay-prep workload1-trace/ust/uid/1000/64-bit workload1
+
+
+Availability
+============
+
+**rbd-replay-prep** is part of the Ceph distributed storage system. Please refer to
+the Ceph documentation at http://ceph.com/docs for more information.
+
+
+See also
+========
+
+:doc:`rbd-replay <rbd-replay>`\(8),
+:doc:`rbd <rbd>`\(8)

diff --git a/doc/man/8/rbd-replay.rst b/doc/man/8/rbd-replay.rst
index 63d74c720eb2c4c2f4c3b3f938c83364ef779e8f..55a607f897c78d4aef735cae408f4bdd5a1c1c6e 100644 (file)
--- a/doc/man/8/rbd-replay.rst
+++ b/doc/man/8/rbd-replay.rst
@@ -64,5 +64,5 @@ the Ceph documentation at http://ceph.com/docs for more information.
 See also
 ========
 
-:doc:`ceph <ceph>`\(8),
+:doc:`rbd-replay-prep <rbd-replay-prep>`\(8),
 :doc:`rbd <rbd>`\(8)

diff --git a/man/Makefile.am b/man/Makefile.am
index dda04b758654dc812c224e3b6eb4ab46d2dcf8ad..4dc71cc208d20f166029c81e02f2c37c4d53a627 100644 (file)
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -27,4 +27,5 @@ dist_man_MANS = \
        ceph-rbdnamer.8 \
        ceph-post-file.8 \
        rbd-fuse.8 \
-       rbd-replay.8
+       rbd-replay.8 \
+       rbd-replay-prep.8

diff --git a/man/rbd-replay-prep.8 b/man/rbd-replay-prep.8
new file mode 100644 (file)
index 0000000..707fe73
--- /dev/null
+++ b/man/rbd-replay-prep.8
@@ -0,0 +1,98 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "RBD-REPLAY-PREP" "8" "August 11, 2014" "dev" "Ceph"
+.SH NAME
+rbd-replay-prep \- prepare captured rados block device (RBD) workloads for replay
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.SH SYNOPSIS
+.nf
+\fBrbd\-replay\-prep\fP [ \-\-window \fIseconds\fP ] \fItrace_dir\fP \fIreplay_file\fP
+.fi
+.sp
+.SH DESCRIPTION
+.sp
+\fBrbd\-replay\-prep\fP processes raw rados block device (RBD) traces to prepare them for \fBrbd\-replay\fP\&.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-\-window seconds
+Requests further apart than \(aqseconds\(aq seconds are assumed to be independent.
+.UNINDENT
+.SH EXAMPLES
+.sp
+To prepare workload1\-trace for replay:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+rbd\-replay\-prep workload1\-trace/ust/uid/1000/64\-bit workload1
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AVAILABILITY
+.sp
+\fBrbd\-replay\-prep\fP is part of the Ceph distributed storage system. Please refer to
+the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
+.SH SEE ALSO
+.sp
+\fBrbd\-replay\fP(8),
+\fBrbd\fP(8)
+.SH COPYRIGHT
+2010-2014, Inktank Storage, Inc. and contributors. Licensed under Creative Commons BY-SA
+.\" Generated by docutils manpage writer.
+.