shaba/lvm2
1
0
Fork 0
mirror of git://sourceware.org/git/lvm2.git synced 2025-01-03 05:18:29 +03:00
Code Releases Activity

Update columns.h comment to describe macro args.

Browse Source
This commit is contained in:
Dave Wysochanski 2009-04-23 16:27:58 +00:00
parent 40907c2928
commit d85cf5d14d
1 changed files with 39 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
lib/report/columns.h
View File

@ -13,9 +13,44 @@
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/* Report type, Containing struct, Field type, Report heading,
* Data field with struct to pass to display function, Minimum display width,
* Display Fn, Unique format identifier */
/*
* This file defines the fields (columns) for the reporting commands
* (pvs/vgs/lvs).
*/
/*
* The 'FIELD' macro arguments are defined as follows:
* 1. report_type. An enum value that selects a specific
* struct dm_report_object_type in the _report_types array. The value is
* used to select the containing base object address (see *obj_get*
* functions) for any data values of any field in the report.
* 2. Containing struct. The structure that either contains the field data
* as a member or should be used to obtain the field data. The containing
* struct should match the base object of the report_type.
* 3. Field type. This must be either 'STR' or 'NUM'.
* 4. Report heading. This is the field heading that is displayed by the
* reporting commands.
* 5. Data value pointer. This argument is is always a member of the
* containing struct. In some cases, the member points to the data value
* of the field (for example, lv_uuid - see _uuid_disp()). In other cases
* it is pointer that may be used to derive the data value (for example,
* seg_count - see _lvsegcount_disp()). In the FIELD macro definition,
* this is used in an offset calculation to derive the offset to the
* data value from the containing struct base address.
* 6. Minimum display width. This is the minimum width used to display
* the field value.
* 7. Display function identifier. Used to derive the full name of the
* function that displays this field. Derivation is done by appending '_'
* then prepending this argument to '_disp'. For example, if this argument
* is 'uuid', the display function is _uuid_disp(). Adding a new field may
* require defining a new display function (for example _myfieldname_disp()),
* or re-use of an existing one (for example, _uint32_disp()).
* 8. Unique format identifier / field id. This name must be unique and is
* used to select fields via '-o' in the reporting commands (pvs/vgs/lvs).
* The string used to specify the field - the 'id' member of
* struct dm_report_field_type.
* 9. Description of field. This is a brief (ideally <= 52 chars) description
* of the field used in the reporting commands.
*/
/* *INDENT-OFF* */
FIELD(LVS, lv, STR, "LV UUID", lvid.id[1], 38, uuid, "lv_uuid", "Unique identifier")