[PATCH] doc: fix snapshot creation/deletion syntax in rbd man page (trivial)

[PATCH] doc: fix snapshot creation/deletion syntax in rbd man page (trivial)

[Florian Haas]

Creating a snapshot requires using "rbd snap create",
as opposed to just "rbd create". Also for purposes of
clarification, add note that removing a snapshot similarly
requires "rbd snap rm".

Thanks to Josh Durgin for the explanation on IRC.
---
 man/rbd.8 |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)

diff --git a/man/rbd.8 b/man/rbd.8
index 0278137..b59c2f6 100644
--- a/man/rbd.8
+++ b/man/rbd.8
@@ -194,7 +194,15 @@ To create a new snapshot:
 .sp
 .nf
 .ft C
-rbd create mypool/myimage@mysnap
+rbd snap create mypool/myimage@mysnap
+.ft P
+.fi
+.sp
+To delete a snapshot:
+.sp
+.nf
+.ft C
+rbd snap rm mypool/myimage@mysnap
 .ft P
 .fi
 .sp
-- 
1.7.5.4

Updated rbd man page patch

[Florian Haas]

Hi,

updated version of the previous patch, after Josh pointed out that
I patched the generated man page, rather than its source.

Cheers,
Florian

[PATCH] doc: fix snapshot creation/deletion syntax in rbd man page (trivial)

[Florian Haas]

Creating a snapshot requires using "rbd snap create",
as opposed to just "rbd create". Also for purposes of
clarification, add note that removing a snapshot similarly
requires "rbd snap rm".

Thanks to Josh Durgin for the explanation on IRC.

Signed-off-by: Florian Haas <florian@hastexo.com>
---
 doc/man/8/rbd.rst |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
index fbf8e3c..7069e30 100644
--- a/doc/man/8/rbd.rst
+++ b/doc/man/8/rbd.rst
@@ -154,7 +154,11 @@ To delete an rbd image (be careful!)::
 
 To create a new snapshot::
 
-       rbd create mypool/myimage@mysnap
+       rbd snap create mypool/myimage@mysnap
+
+To delete a snapshot::
+
+       rbd snap rm mypool/myimage@mysnap
 
 To map an image via the kernel with cephx enabled::
 
-- 
1.7.5.4

Re: [PATCH] doc: fix snapshot creation/deletion syntax in rbd man page (trivial)

[Josh Durgin]

On 02/17/2012 12:15 PM, Florian Haas wrote:
> Creating a snapshot requires using "rbd snap create",
> as opposed to just "rbd create". Also for purposes of
> clarification, add note that removing a snapshot similarly
> requires "rbd snap rm".
>
> Thanks to Josh Durgin for the explanation on IRC.
>
> Signed-off-by: Florian Haas<florian@hastexo.com>
> ---
>   doc/man/8/rbd.rst |    6 +++++-
>   1 files changed, 5 insertions(+), 1 deletions(-)
>
> diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
> index fbf8e3c..7069e30 100644
> --- a/doc/man/8/rbd.rst
> +++ b/doc/man/8/rbd.rst
> @@ -154,7 +154,11 @@ To delete an rbd image (be careful!)::
>
>   To create a new snapshot::
>
> -       rbd create mypool/myimage@mysnap
> +       rbd snap create mypool/myimage@mysnap
> +
> +To delete a snapshot::
> +
> +       rbd snap rm mypool/myimage@mysnap
>
>   To map an image via the kernel with cephx enabled::
>

Applied, thanks!