1
0
mirror of git://sourceware.org/git/lvm2.git synced 2025-03-11 20:58:50 +03:00

commands: SECONDARY flag changes in cmd defs

Add/remove the SECONDARY_SYNTAX flag to cmd defs.
cmd defs with this flag will be listed under the
ADVANCED USAGE man page section, so that the main
USAGE section contains the most common commands
without distraction.

- When multiple cmd defs do the same thing, one variant
  can be displayed in the first list.
- Very advanced, unusual or uncommon commands should be
  in the second list.
This commit is contained in:
David Teigland 2017-02-28 16:15:11 -06:00
parent d6dd700bf7
commit eb9586bd3b

View File

@ -340,6 +340,7 @@ OP: PV ...
ID: lvconvert_raid_types ID: lvconvert_raid_types
DESC: Convert LV to type mirror (also see type raid1). DESC: Convert LV to type mirror (also see type raid1).
RULE: all not lv_is_locked lv_is_pvmove RULE: all not lv_is_locked lv_is_pvmove
FLAGS: SECONDARY_SYNTAX
# When LV is already raid, this changes the raid layout # When LV is already raid, this changes the raid layout
# (changing layout of raid0 and raid1 not allowed.) # (changing layout of raid0 and raid1 not allowed.)
@ -379,6 +380,7 @@ ID: lvconvert_change_region_size
DESC: Change the region size of an LV. DESC: Change the region size of an LV.
RULE: all not lv_is_locked lv_is_pvmove RULE: all not lv_is_locked lv_is_pvmove
RULE: all not LV_raid0 RULE: all not LV_raid0
FLAGS: SECONDARY_SYNTAX
--- ---
@ -411,6 +413,7 @@ OP: PV ...
ID: lvconvert_change_mirrorlog ID: lvconvert_change_mirrorlog
DESC: Change the type of mirror log used by a mirror LV. DESC: Change the type of mirror log used by a mirror LV.
RULE: all not lv_is_locked lv_is_pvmove RULE: all not lv_is_locked lv_is_pvmove
FLAGS: SECONDARY_SYNTAX
--- ---
@ -543,6 +546,7 @@ lvconvert --uncache LV_cache_thinpool
OO: OO_LVCONVERT OO: OO_LVCONVERT
ID: lvconvert_split_and_remove_cachepool ID: lvconvert_split_and_remove_cachepool
DESC: Separate and delete the cache pool from a cache LV. DESC: Separate and delete the cache pool from a cache LV.
FLAGS: SECONDARY_SYNTAX
--- ---
@ -550,6 +554,7 @@ lvconvert --swapmetadata --poolmetadata LV LV_thinpool_cachepool
OO: --chunksize SizeKB, OO_LVCONVERT OO: --chunksize SizeKB, OO_LVCONVERT
ID: lvconvert_swap_pool_metadata ID: lvconvert_swap_pool_metadata
DESC: Swap metadata LV in a thin pool or cache pool (for repair only). DESC: Swap metadata LV in a thin pool or cache pool (for repair only).
FLAGS: SECONDARY_SYNTAX
--- ---
@ -597,6 +602,7 @@ OO: OO_LVCONVERT
ID: lvconvert_split_cow_snapshot ID: lvconvert_split_cow_snapshot
DESC: Separate a COW snapshot from its origin LV. DESC: Separate a COW snapshot from its origin LV.
RULE: all not lv_is_locked lv_is_pvmove lv_is_origin lv_is_external_origin lv_is_merging_cow RULE: all not lv_is_locked lv_is_pvmove lv_is_origin lv_is_external_origin lv_is_merging_cow
FLAGS: SECONDARY_SYNTAX
--- ---
@ -614,9 +620,9 @@ OO: --snapshot, --chunksize SizeKB, --zero Bool, OO_LVCONVERT
ID: lvconvert_combine_split_snapshot ID: lvconvert_combine_split_snapshot
DESC: Combine a former COW snapshot (second arg) with a former DESC: Combine a former COW snapshot (second arg) with a former
DESC: origin LV (first arg) to reverse a splitsnapshot command. DESC: origin LV (first arg) to reverse a splitsnapshot command.
FLAGS: SECONDARY_SYNTAX
RULE: all not lv_is_locked lv_is_pvmove RULE: all not lv_is_locked lv_is_pvmove
RULE: all and lv_is_visible RULE: all and lv_is_visible
FLAGS: SECONDARY_SYNTAX
lvconvert --snapshot LV LV_linear lvconvert --snapshot LV LV_linear
OO: --type snapshot, --chunksize SizeKB, --zero Bool, OO_LVCONVERT OO: --type snapshot, --chunksize SizeKB, --zero Bool, OO_LVCONVERT
@ -625,6 +631,7 @@ DESC: Combine a former COW snapshot (second arg) with a former
DESC: origin LV (first arg) to reverse a splitsnapshot command. DESC: origin LV (first arg) to reverse a splitsnapshot command.
RULE: all not lv_is_locked lv_is_pvmove RULE: all not lv_is_locked lv_is_pvmove
RULE: all and lv_is_visible RULE: all and lv_is_visible
FLAGS: SECONDARY_SYNTAX
--- ---
@ -745,6 +752,7 @@ OO: --stripes Number, --stripesize SizeKB, OO_LVCREATE
OP: PV ... OP: PV ...
ID: lvcreate_striped ID: lvcreate_striped
DESC: Create a striped LV. DESC: Create a striped LV.
FLAGS: SECONDARY_SYNTAX
lvcreate --stripes Number --size SizeMB VG lvcreate --stripes Number --size SizeMB VG
OO: --type striped, --stripesize SizeKB, OO_LVCREATE OO: --type striped, --stripesize SizeKB, OO_LVCREATE
@ -759,6 +767,7 @@ OO: --mirrors SNumber, --mirrorlog MirrorLog, --regionsize RegionSize, --stripes
OP: PV ... OP: PV ...
ID: lvcreate_mirror ID: lvcreate_mirror
DESC: Create a mirror LV (also see --type raid1). DESC: Create a mirror LV (also see --type raid1).
FLAGS: SECONDARY_SYNTAX
# alternate form of lvcreate --type raid1|mirror # alternate form of lvcreate --type raid1|mirror
lvcreate --mirrors SNumber --size SizeMB VG lvcreate --mirrors SNumber --size SizeMB VG
@ -816,6 +825,7 @@ OO: --type snapshot, --chunksize SizeKB, OO_LVCREATE
OP: PV ... OP: PV ...
ID: lvcreate_cow_snapshot_with_virtual_origin ID: lvcreate_cow_snapshot_with_virtual_origin
DESC: Create a sparse COW snapshot LV of a virtual origin LV. DESC: Create a sparse COW snapshot LV of a virtual origin LV.
FLAGS: SECONDARY_SYNTAX
--- ---
@ -877,6 +887,7 @@ OO: --thin, OO_LVCREATE_POOL, OO_LVCREATE_THIN, OO_LVCREATE
IO: --mirrors 0 IO: --mirrors 0
ID: lvcreate_thin_vol ID: lvcreate_thin_vol
DESC: Create a thin LV in a thin pool. DESC: Create a thin LV in a thin pool.
FLAGS: SECONDARY_SYNTAX
# alternate form of lvcreate --type thin # alternate form of lvcreate --type thin
lvcreate --type thin --virtualsize SizeMB LV_thinpool lvcreate --type thin --virtualsize SizeMB LV_thinpool
@ -896,7 +907,6 @@ OO: --type thin, --thin, OO_LVCREATE_THIN, OO_LVCREATE
IO: --mirrors 0 IO: --mirrors 0
ID: lvcreate_thin_vol ID: lvcreate_thin_vol
DESC: Create a thin LV in a thin pool (variant, infers --type thin). DESC: Create a thin LV in a thin pool (variant, infers --type thin).
FLAGS: SECONDARY_SYNTAX
# alternate form of lvcreate --type thin # alternate form of lvcreate --type thin
lvcreate --virtualsize SizeMB LV_thinpool lvcreate --virtualsize SizeMB LV_thinpool
@ -915,6 +925,7 @@ OO: --thin, OO_LVCREATE_THIN, OO_LVCREATE
IO: --mirrors 0 IO: --mirrors 0
ID: lvcreate_thin_snapshot ID: lvcreate_thin_snapshot
DESC: Create a thin LV that is a snapshot of an existing thin LV. DESC: Create a thin LV that is a snapshot of an existing thin LV.
FLAGS: SECONDARY_SYNTAX
# alternate form of lvcreate --type thin # alternate form of lvcreate --type thin
lvcreate --thin LV_thin lvcreate --thin LV_thin
@ -946,6 +957,7 @@ IO: --mirrors 0
ID: lvcreate_thin_snapshot_of_external ID: lvcreate_thin_snapshot_of_external
DESC: Create a thin LV that is a snapshot of an external origin LV DESC: Create a thin LV that is a snapshot of an external origin LV
DESC: (infers --type thin). DESC: (infers --type thin).
FLAGS: SECONDARY_SYNTAX
--- ---
@ -1153,7 +1165,6 @@ OO: --alloc Alloc, --autobackup Bool, --force, --mirrors SNumber,
--type SegType --type SegType
ID: lvextend_by_pv ID: lvextend_by_pv
DESC: Extend an LV by specified PV extents. DESC: Extend an LV by specified PV extents.
FLAGS: SECONDARY_SYNTAX
lvextend --poolmetadatasize SizeMB LV_thinpool lvextend --poolmetadatasize SizeMB LV_thinpool
OO: --alloc Alloc, --autobackup Bool, --force, --mirrors SNumber, OO: --alloc Alloc, --autobackup Bool, --force, --mirrors SNumber,
@ -1226,7 +1237,6 @@ OO: --alloc Alloc, --autobackup Bool, --force,
--type SegType --type SegType
ID: lvresize_by_pv ID: lvresize_by_pv
DESC: Resize an LV by specified PV extents. DESC: Resize an LV by specified PV extents.
FLAGS: SECONDARY_SYNTAX
lvresize --poolmetadatasize SizeMB LV_thinpool lvresize --poolmetadatasize SizeMB LV_thinpool
OO: --alloc Alloc, --autobackup Bool, --force, OO: --alloc Alloc, --autobackup Bool, --force,
@ -1504,7 +1514,6 @@ vgexport --all
OO: OO_VGEXPORT OO: OO_VGEXPORT
ID: vgexport_all ID: vgexport_all
DESC: Export all VGs. DESC: Export all VGs.
FLAGS: SECONDARY_SYNTAX
--- ---
@ -1628,14 +1637,12 @@ config
OO: OO_CONFIG OO: OO_CONFIG
OP: String ... OP: String ...
ID: lvmconfig_general ID: lvmconfig_general
FLAGS: SECONDARY_SYNTAX
# use lvmconfig # use lvmconfig
dumpconfig dumpconfig
OO: OO_CONFIG OO: OO_CONFIG
OP: String ... OP: String ...
ID: lvmconfig_general ID: lvmconfig_general
FLAGS: SECONDARY_SYNTAX
devtypes devtypes
OO: --aligned, --binary, --nameprefixes, --noheadings, OO: --aligned, --binary, --nameprefixes, --noheadings,
@ -1669,7 +1676,6 @@ ID: version_general
# deprecated # deprecated
pvdata pvdata
ID: pvdata_general ID: pvdata_general
FLAGS: SECONDARY_SYNTAX
segtypes segtypes
ID: segtypes_general ID: segtypes_general
@ -1683,22 +1689,18 @@ ID: tags_general
# deprecated # deprecated
lvmchange lvmchange
ID: lvmchange_general ID: lvmchange_general
FLAGS: SECONDARY_SYNTAX
# deprecated # deprecated
lvmdiskscan lvmdiskscan
OO: --lvmpartition, --readonly OO: --lvmpartition, --readonly
ID: lvmdiskscan_general ID: lvmdiskscan_general
FLAGS: SECONDARY_SYNTAX
# deprecated # deprecated
lvmsadc lvmsadc
ID: lvmsadc_general ID: lvmsadc_general
FLAGS: SECONDARY_SYNTAX
# deprecated # deprecated
lvmsar lvmsar
OO: --full, --stdin OO: --full, --stdin
ID: lvmsar_general ID: lvmsar_general
FLAGS: SECONDARY_SYNTAX