Skip to content

Commit

Permalink
rbd: update manpage for clone command
Browse files Browse the repository at this point in the history
Signed-off-by: Dan Mick <[email protected]>
  • Loading branch information
Dan Mick committed Jul 10, 2012
1 parent e353149 commit 2a6af20
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
8 changes: 8 additions & 0 deletions doc/man/8/rbd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,10 @@ Commands
:command:`create` [*image-name*]
Will create a new rbd image. You must also specify the size via --size.

:command:`clone` [*parent-snapname*] [*image-name*]
Will create a clone (copy-on-write child) of the parent snapshot.
Size and object order will be identical to parent image unless specified.

:command:`resize` [*image-name*]
Resizes rbd image. The size parameter also needs to be specified.

Expand Down Expand Up @@ -156,6 +160,10 @@ To create a new snapshot::

rbd snap create mypool/myimage@mysnap

To create a copy-on-write clone of a snapshot::

rbd clone myimage@mysnap cloneimage

To delete a snapshot::

rbd snap rm mypool/myimage@mysnap
Expand Down
21 changes: 16 additions & 5 deletions man/rbd.8
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH "RBD" "8" "May 02, 2012" "dev" "Ceph"
.TH "RBD" "8" "July 10, 2012" "dev" "Ceph"
.SH NAME
rbd \- manage rados block device (RBD) images
.
Expand Down Expand Up @@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
.nf
Expand Down Expand Up @@ -99,6 +99,10 @@ Will dump information (such as size and order) about a specific rbd image.
.B \fBcreate\fP [\fIimage\-name\fP]
Will create a new rbd image. You must also specify the size via \-\-size.
.TP
.B \fBclone\fP [\fIparent\-snapname\fP] [\fIimage\-name\fP]
Will create a clone (copy\-on\-write child) of the parent snapshot.
Size and object order will be identical to parent image unless specified.
.TP
.B \fBresize\fP [\fIimage\-name\fP]
Resizes rbd image. The size parameter also needs to be specified.
.TP
Expand Down Expand Up @@ -198,6 +202,14 @@ rbd snap create mypool/myimage@mysnap
.ft P
.fi
.sp
To create a copy\-on\-write clone of a snapshot:
.sp
.nf
.ft C
rbd clone myimage@mysnap cloneimage
.ft P
.fi
.sp
To delete a snapshot:
.sp
.nf
Expand All @@ -224,13 +236,12 @@ rbd unmap /dev/rbd0
.SH AVAILABILITY
.sp
\fBrbd\fP is part of the Ceph distributed file system. Please refer to
the Ceph wiki at \fI\%http://ceph.newdream.net/wiki\fP for more information.
the Ceph documentation at \fI\%http://ceph.com/docs\fP for more information.
.SH SEE ALSO
.sp
\fBceph\fP(8),
\fBrados\fP(8)
.SH COPYRIGHT
2011, New Dream Network
2012, Inktank Storage, Inc.
.\" Generated by docutils manpage writer.
.\"
.

0 comments on commit 2a6af20

Please sign in to comment.