Bug 1210619

Summary: [RFE] Add support for "<lvm reporting command> -o help <field_name>" to display more details about the field and its values
Product: [Fedora] Fedora Reporter: Peter Rajnoha <prajnoha>
Component: lvm2Assignee: Peter Rajnoha <prajnoha>
Status: NEW --- QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: low Docs Contact:
Priority: low    
Version: rawhideCC: agk, bmarzins, bmr, dwysocha, heinzm, jonathan, lvm-team, msnitzer, prajnoha, zkabelac
Target Milestone: ---Keywords: FutureFeature
Target Release: ---   
Hardware: All   
OS: Linux   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Peter Rajnoha 2015-04-10 08:31:27 UTC 
Enhance help for each reporting field so that users can check valid values for each field easily by using "-o help <field_name>". Such field-specific help would include brief description of the field (we actually have this in the "-o help" already more or less) and stating possible valid value ranges this field can display, including undefined values and any synonyms which are recognized for -S|--select criteria.

For example:

  lvs -o help lv_role

...would display all possible LV roles. This way, users know what values they can expect and they can add proper checks in their scripts.
Comment 1 Peter Rajnoha 2015-04-10 08:52:50 UTC 
Also, while in this area, try making it easier for people to search for fields since we have lots of them now and they didn't even fit into one usual screen (80 lines) anymore (currently there are 191 lines printed so it scrolls most of the time).

So try adding support for wildcards like "-o help cache_*", also searching through substrings (both in field names and descriptions) or any other improvements that may help users to navigate through the list of fields which LVM can report.