doc/man/ceph-volume add docs for zap sub-command

Signed-off-by: Alfredo Deza <adeza@redhat.com>

diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst
index 2eb72cc976a9b5287f5eeeb7e18f250f252d04ea..f5d66d3792bf51284eac4f9c3a986ccd7afe0c79 100644 (file)
--- a/doc/man/8/ceph-volume.rst
+++ b/doc/man/8/ceph-volume.rst
@@ -135,6 +135,26 @@ Positional arguments:
   ``/path/to/sda1`` for regular devices.
 
 
+**zap**
+Zaps the given logical volume or partition. If given a path to a logical
+volume it must be in the format of vg/lv. Any filesystems present
+on the given lv or partition will be removed and all data will be purged.
+
+However, the lv or partition will be kept intact.
+
+Usage, for logical volumes::
+
+      ceph-volume lvm zap {vg/lv}
+
+Usage, for logical partitions::
+
+      ceph-volume lvm zap /dev/sdc1
+
+Positional arguments:
+
+* <DEVICE>  Either in the form of ``vg/lv`` for logical volumes or
+  ``/path/to/sda1`` for regular devices.
+
 Availability
 ============