summaryrefslogtreecommitdiffstats
path: root/commands/storage/doc
diff options
context:
space:
mode:
authorMichal Minar <miminar@redhat.com>2014-02-24 16:36:06 +0100
committerMichal Minar <miminar@redhat.com>2014-02-24 16:57:24 +0100
commite79ae5925949685c71c66d1277b45c5f72700e80 (patch)
tree6ebe110489931c127c907dba70ce5b22eb06d272 /commands/storage/doc
parent1139d38511926b569eb29e4fec0a1fcc696bca21 (diff)
downloadopenlmi-scripts-e79ae5925949685c71c66d1277b45c5f72700e80.tar.gz
openlmi-scripts-e79ae5925949685c71c66d1277b45c5f72700e80.tar.xz
openlmi-scripts-e79ae5925949685c71c66d1277b45c5f72700e80.zip
documentation updates
Added few Makefiles and setup configs. Just to make distribution to PyPI easy.
Diffstat (limited to 'commands/storage/doc')
-rw-r--r--commands/storage/doc/cmdline.generated134
-rw-r--r--commands/storage/doc/conf.py4
2 files changed, 130 insertions, 8 deletions
diff --git a/commands/storage/doc/cmdline.generated b/commands/storage/doc/cmdline.generated
index a992947..cfb2fa2 100644
--- a/commands/storage/doc/cmdline.generated
+++ b/commands/storage/doc/cmdline.generated
@@ -27,6 +27,10 @@ Basic storage device information.
**lmi** **storage** **vg** \ *<cmd>*\ [\ *<args>*\ ...]
+ **lmi** **storage** **thinpool** \ *<cmd>*\ [\ *<args>*\ ...]
+
+ **lmi** **storage** **thinlv** \ *<cmd>*\ [\ *<args>*\ ...]
+
**lmi** **storage** **depends** [ \ **--deep**\ ] [ \ *<device>*\ ...]
**lmi** **storage** **list** [ \ *<device>*\ ...]
@@ -74,6 +78,14 @@ Basic storage device information.
Volume Group management.
+ **thinpool**
+ Thin Pool management.
+
+
+ **thinlv**
+ Thin Logical Volume management.
+
+
**list**
List short information about given device. If no devices
are given, all devices are listed.
@@ -339,7 +351,7 @@ Mount management.
**lmi** **storage** **mount** **list** [ \ **--all**\ ] [ \ *<device>*\ ... ]
- **lmi** **storage** **mount** **create** \ *<device>*\ \ *<mountpoint>*\ [ (\ **-t**\ \ *<fs_type>*\ ) (\ **-o**\ \ *<options>*\ ) (\ **-p**\ \ *<other_options>*\ ) ]
+ **lmi** **storage** **mount** **create** \ *<device>*\ \ *<mountpoint>*\ [ (\ **-t**\ \ *<fs_type>*\ ) (\ **-o**\ \ *<options>*\ ) ]
**lmi** **storage** **mount** **delete** \ *<target>*\
@@ -361,12 +373,12 @@ Mount management.
independent) and filesystem specific options can be provided. If no
filesystem type is specified, it is automatically detected.
- Common options can be provided as a comma-separated string of
+ Options can be provided as a comma-separated string of
'option_name:value' items. Possible option names are:
AllowExecution AllowMandatoryLock AllowSUID AllowUserMount
AllowWrite Auto Dump FileSystemCheckOrder InterpretDevices
- OtherOptions Silent SynchronousDirectoryUpdates SynchronousIO
+ Silent SynchronousDirectoryUpdates SynchronousIO
UpdateAccessTimes UpdateDirectoryAccessTimes UpdateFullAccessTimes
UpdateRelativeAccessTimes
@@ -375,7 +387,8 @@ Mount management.
case insensitive.
The FileSystemCheckOrder option's value is a number.
- Other options can be specified as a string.
+ In case an option is not recognized as being one of the possible
+ options listed above, it's used as a filesystem dependent option.
Examples:
@@ -383,9 +396,9 @@ Mount management.
create /dev/vda2 /mnt -o 'FileSystemCheckOrder:2'
- create /dev/vda3 /mnt -p 'user_xattr,barrier=0'
+ create /dev/vda3 /mnt -o 'user_xattr,barrier=0'
- create /dev/vda4 /mnt -o 'Dump:t, AllowMandatoryLock:t' -p 'acl'
+ create /dev/vda4 /mnt -o 'Dump:t, AllowMandatoryLock:t, acl'
**delete**
@@ -684,3 +697,112 @@ Volume Group management.
(=1024 bytes).
The suffix is case insensitive, i.e. 1g = 1G = 1073741824 bytes.
+storage thinpool
+----------------
+
+Thin Pool management.
+
+
+**Usage:**
+
+ **lmi** **storage** **thinpool** list
+
+ **lmi** **storage** **thinpool** **create** \ *<name>*\ \ *<vg>*\ \ *<size>*\
+
+ **lmi** **storage** **thinpool** **delete** \ *<tp>*\ ...
+
+ **lmi** **storage** **thinpool** **show** [ \ *<tp>*\ ...]
+
+
+
+**Commands:**
+
+
+ **list**
+ List all thin pools on the system.
+
+
+ **create**
+ Create Thin Pool with given name and size from a Volume Group.
+
+
+ **delete**
+ Delete given Thin Pools.
+
+
+ **show**
+ Show detailed information about given Thin Pools. If no
+ Thin Pools are provided, all of them are displayed.
+
+**Options:**
+
+
+ **vg**
+ Name of the volume group, with or without `/dev/` prefix.
+
+
+ **tp**
+ Name of the thin pool, with or without `/dev/` prefix.
+
+
+ **size**
+ Requested extent size of the new volume group, by default in
+ bytes. 'T', 'G', 'M' or 'K' suffix can be used to specify
+ other units (TiB, GiB, MiB and KiB) - '1K' specifies 1 KiB
+ (=1024 bytes).
+ The suffix is case insensitive, i.e. 1g = 1G = 1073741824 bytes.
+
+storage thinlv
+--------------
+
+Thin Logical Volume management.
+
+
+**Usage:**
+
+ **lmi** **storage** **thinlv** **list** [ \ *<tp>*\ ...]
+
+ **lmi** **storage** **thinlv** **create** \ *<tp>*\ \ *<name>*\ \ *<size>*\
+
+ **lmi** **storage** **thinlv** **delete** \ *<tlv>*\ ...
+
+ **lmi** **storage** **thinlv** **show** [ \ *<tlv>*\ ...]
+
+
+
+**Commands:**
+
+
+ **list**
+ List available thin logical volumes on given thin pools.
+ If no thin pools are provided, all thin logical volumes are
+ listed.
+
+
+ **create**
+ Create a thin logical volume on given thin pool.
+
+
+ **delete**
+ Delete given thin logical volume.
+
+
+ **show**
+ Show detailed information about given Thin Logical Volumes. If no
+ Thin Logical Volumes are provided, all of them are displayed.
+
+**Options:**
+
+
+ **tp**
+ Name of the thin pool, with or without `/dev/` prefix.
+
+
+ **size**
+ Size of the new logical volume, by default in bytes.
+ 'T', 'G', 'M' or 'K' suffix can be used to specify other
+ units (TiB, GiB, MiB and KiB) - '1K' specifies 1 KiB
+ (= 1024 bytes).
+ The suffix is case insensitive, i.e. 1g = 1G = 1073741824
+ bytes.
+
diff --git a/commands/storage/doc/conf.py b/commands/storage/doc/conf.py
index c936c81..2108745 100644
--- a/commands/storage/doc/conf.py
+++ b/commands/storage/doc/conf.py
@@ -48,9 +48,9 @@ copyright = u'2013-2014, Red Hat, Inc.'
# built documents.
#
# The short X.Y version.
-version = '0.0.3'
+version = '0.0.4'
# The full version, including alpha/beta/rc tags.
-release = '0.0.3'
+release = '0.0.4'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.