= ruby-lvm-attrib

* http://ruby-lvm-attrib.rubyforge.org
* mailto:mkent@magoazul.com

== DESCRIPTION:

This is a list of attributes for lvm objects. They are generated from the 
source code and broken down by version. See ADDING ATTRIBUTES below
to contribute.

At their core these files exist to determine which arguments to pass
lvs/vgs/pvs and the subsequent type conversions.

Currently this is split from the main ruby-lvm gem since these files require
updating to follow LVM2 releases.

== FEATURES/PROBLEMS:

* This library may go away depending on future progress of ruby-lvm.

== SYNOPSIS:

  require 'lvm/attributes'

  attributes = Attributes.load("2.0.36", "vgs.yaml")

== REQUIREMENTS:

* None

== INSTALL:

* sudo gem install ruby-lvm-attrib

== ADDING ATTRIBUTES:

To add attributes:
* Download and extract LVM2 source version from: http://git.fedorahosted.org/cgit/lvm2.git/refs/tags
* Fork this repository
* `git clone your-forked-repo`
* `cd your-forked-repo`
* `git checkout -b mybranch`
* `bin/generate_field_data path/to/lvm2-source`
  * See missing attribute type note below if there's issues, otherwise will just return "Done."
* `mv LVM_VERSION_FULL lib/lvm/attributes/LVM_VERSION`
  * LVM_VERSION_FULL being something like 2.02.86(2)-cvs or 2.02.98(2)-git
  * LVM_VERSION being something like 2.02.86(2) or 2.02.98(2)
* `git commit -am "Added LVM_VERSION attributes"`
* `git push origin mybranch`
* Submit PR to this repository. Please make sure to point your pull at the
  `next` branch -- NOT MASTER!

=== MISSING ATTRIBUTE TYPE:

If you get an error like the below:

    Oops, missing type conversion data of column 'discards' use by 'SEGS' which says its going to return a 'discards'
    Figure out the missing type and rerun.

* Look in `path/to/lvm-source/lib/report/columns.rb` for the column name in the 7th field.
* If the 3rd field is NUM, type will be Integer. If 3rd field is STR, type will be String.
* Add the information to `bin/generate_field_data` in the TYPE_CONVERSION_MAP and try running again

== FEEDBACK:

Please feel free to submit patches or constructive criticism, I'm still pretty
new to ruby and object oriented programming in general.

== LICENSE:

(The MIT License)

Copyright (c) 2008 Matthew Kent, Bravenet Web Services Inc. 

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.