From: Alfredo Deza <adeza@redhat.com>
Date: Mon, 22 Jan 2018 17:06:25 +0000 (-0500)
Subject: doc/man/ceph-volume add docs for zap sub-command
X-Git-Tag: v12.2.3~27^2~2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=5a7b50f121aee3fc13474b42e11b5d19a36d7764;p=ceph.git

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

Signed-off-by: Alfredo Deza <adeza@redhat.com>
(cherry picked from commit ad73be2c2a6ee273d37b706626974d6900742256)
---

diff --git a/doc/man/8/ceph-volume.rst b/doc/man/8/ceph-volume.rst
index aea91251b12..3898a861f1b 100644
--- 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
 ============