doc/rbd: document cp versus deep cp

I found that the difference between "rbd cp" and "rbd deep cp",
i.e. what "deep" means in this context, is documented only in
the mailing list archive and in the Mimic reelase notes.

Let's make the difference explicit in the manpage and in rbd --help.

Signed-off-by: Jan "Yenya" Kasprzak <kas@fi.muni.cz>

diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst
index cdef0ef4d6032cbe3222dbe1337d790ce37e9c51..7c61d0a5dd7a20c04765c429dd2bca5f957c45d6 100644 (file)
--- a/doc/man/8/rbd.rst
+++ b/doc/man/8/rbd.rst
@@ -237,6 +237,8 @@ Commands
 :command:`cp` (*src-image-spec* | *src-snap-spec*) *dest-image-spec*
   Copy the content of a src-image into the newly created dest-image.
   dest-image will have the same size, object size, and image format as src-image.
+  Note: snapshots are not copied, use `deep cp` command to include
+  snapshots.
 
 :command:`create` (-s | --size *size-in-M/G/T*) [--image-format *format-id*] [--object-size *size-in-B/K/M*] [--stripe-unit *size-in-B/K/M* --stripe-count *num*] [--thick-provision] [--no-progress] [--image-feature *feature-name*]... [--image-shared] *image-spec*
   Will create a new rbd image. You must also specify the size via --size.  The

diff --git a/src/test/cli/rbd/help.t b/src/test/cli/rbd/help.t
index 993ed2a1d7bef84dbd0de5f8eeb66952eaa52f8e..3f4c54377873c1cb825fddfd402f30a847972cc3 100644 (file)
--- a/src/test/cli/rbd/help.t
+++ b/src/test/cli/rbd/help.t
@@ -26,7 +26,8 @@
       config pool set                   Set a pool-level configuration override.
       copy (cp)                         Copy src image to dest.
       create                            Create an empty image.
-      deep copy (deep cp)               Deep copy src image to dest.
+      deep copy (deep cp)               Deep copy (including snapshots) src image
+                                        to dest.
       device attach                     Attach image to device.
       device detach                     Detach image from device.
       device list (showmapped)          List mapped rbd images.
@@ -533,7 +534,7 @@
                        [--no-progress] 
                        <source-image-or-snap-spec> <dest-image-spec> 
   
-  Deep copy src image to dest.
+  Deep copy (including snapshots) src image to dest.
   
   Positional arguments
     <source-image-or-snap-spec>  source image or snapshot specification

diff --git a/src/tools/rbd/action/Copy.cc b/src/tools/rbd/action/Copy.cc
index 9a248437109057c7cde1a4a03401ebe4a39a63af..9e42c06529df5f3aa36bb15e7cedefb2e8a17e27 100644 (file)
--- a/src/tools/rbd/action/Copy.cc
+++ b/src/tools/rbd/action/Copy.cc
@@ -187,7 +187,7 @@ int execute_deep(const po::variables_map &vm,
 }
 
 Shell::Action action_deep(
-  {"deep", "copy"}, {"deep", "cp"}, "Deep copy src image to dest.",
+  {"deep", "copy"}, {"deep", "cp"}, "Deep copy (including snapshots) src image to dest.",
   at::get_long_features_help(), &get_arguments_deep, &execute_deep);
 
 } // namespace copy