From 57471fe7e74c94351e713ff99cbcbaa7dc6a0f52 Mon Sep 17 00:00:00 2001 From: Andrew Schoen Date: Thu, 18 Jan 2018 14:54:55 -0600 Subject: [PATCH] ceph-volume: clean up docstrings for lvm zap Signed-off-by: Andrew Schoen --- src/ceph-volume/ceph_volume/api/lvm.py | 2 ++ src/ceph-volume/ceph_volume/devices/lvm/zap.py | 9 ++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/ceph-volume/ceph_volume/api/lvm.py b/src/ceph-volume/ceph_volume/api/lvm.py index 374834b32c17d..868effb8309b7 100644 --- a/src/ceph-volume/ceph_volume/api/lvm.py +++ b/src/ceph-volume/ceph_volume/api/lvm.py @@ -115,6 +115,8 @@ def get_api_pvs(): Return the list of physical volumes configured for lvm and available in the system using flags to include common metadata associated with them like the uuid + This will only return physical volumes set up to work with LVM. + Command and delimeted output, should look like:: $ pvs --noheadings --separator=';' -o pv_name,pv_tags,pv_uuid diff --git a/src/ceph-volume/ceph_volume/devices/lvm/zap.py b/src/ceph-volume/ceph_volume/devices/lvm/zap.py index 22637d0832f4a..dda21d2b89c97 100644 --- a/src/ceph-volume/ceph_volume/devices/lvm/zap.py +++ b/src/ceph-volume/ceph_volume/devices/lvm/zap.py @@ -89,7 +89,7 @@ class Zap(object): sub_command_help = dedent(""" Zaps the given logical volume, raw device or partition for reuse by ceph-volume. If given a path to a logical volume it must be in the format of vg/lv. Any - filesystems present on the given device/lv/partition will be removed and + filesystems present on the given device, vg/lv, or partition will be removed and all data will be purged. However, the lv or partition will be kept intact. @@ -105,11 +105,10 @@ class Zap(object): ceph-volume lvm zap /dev/sdc1 If the --destroy flag is given and you are zapping a raw device or partition - then all vgs and lvs that exist on that raw device or parition will be destroyed. + then all vgs and lvs that exist on that raw device or partition will be destroyed. - This is especially useful if you've give that raw device or partition to the - ceph-volume lvm create or ceph-volume lvm prepare commands previously and now want to - reuse that device. + This is especially useful if a raw device or partition was used by ceph-volume lvm create + or ceph-volume lvm prepare commands previously and now you want to reuse that device. For example: -- 2.39.5