xanderio/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Make man pages for new types to be by convention. Fix spellings.

Browse source
This commit is contained in:
Darko Poljak 2016-08-18 10:41:58 +02:00
parent 52a2315cd1
commit f40e6659f7
3 changed files with 23 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
cdist/conf/type/__filesystem/man.rst
View file

@ -10,17 +10,17 @@ DESCRIPTION
----------- -----------
This cdist type allows you to create filesystems on devices. This cdist type allows you to create filesystems on devices.
If the device is mounted on target, it refuses to do someting. If the device is mounted on target, it refuses to do anything.
If the device has a filesystem other as the specified and/or If the device has a filesystem other then the specified and/or
the label is not correct, it only make a new filesystem the label is not correct, it only makes a new filesystem
if you specified --force option if you have specified --force option.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
fstype fstype
Filesystem type, for example 'ext3', 'btrfs' or 'xfs' Filesystem type, for example 'ext3', 'btrfs' or 'xfs'.
@ -28,15 +28,16 @@ OPTIONAL PARAMETERS
------------------- -------------------
device device
Blockdevice for filesystem, Defaults to object_id. Blockdevice for filesystem, Defaults to object_id.
On linux, it can be any by lsblk accepted device notation On linux, it can be any lsblk accepted device notation.
for example |
/dev/sdx | For example:
or /dev/disk/by-xxxx/xxx | /dev/sdx
or /dev/mapper/xxxx | or /dev/disk/by-xxxx/xxx
| or /dev/mapper/xxxx
label label
Label which sould apply on the filesystem Label which sould apply on the filesystem.
mkfsoptions mkfsoptions
Additional options which are inserted to the mkfs.xxx call. Additional options which are inserted to the mkfs.xxx call.
@ -46,13 +47,13 @@ BOOLEAN PARAMETERS
------------------ ------------------
force force
Normaly, this type does nothing if a filesystem is found Normaly, this type does nothing if a filesystem is found
on the target device. If you specify force, its formated on the target device. If you specify force, it's formated
if the filesystem type or label differs from parameters if the filesystem type or label differs from parameters.
Warning: This option can easy lead into data loss ! Warning: This option can easily lead into data loss!
MESSAGES MESSAGES
-------- --------
filesystem <fstype> on <device> : <discoverd device> created filesystem <fstype> on <device> \: <discoverd device> created
Filesytem was created on <discoverd device> Filesytem was created on <discoverd device>

12
cdist/conf/type/__locale_system/man.rst
View file

@ -10,7 +10,7 @@ DESCRIPTION
----------- -----------
This cdist type allows you to modify system-wide locale. This cdist type allows you to modify system-wide locale.
The name of the locale category is given as the object id The name of the locale category is given as the object id
(usually you are probably interested in using LANG) (usually you are probably interested in using LANG).
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
@ -47,16 +47,14 @@ EXAMPLES
SEE ALSO SEE ALSO
-------- --------
:strong:`locale`\ (1) :strong:`locale`\ (1), :strong:`localedef`\ (1), :strong:`cdist-type__locale`\ (7)
:strong:`localedef`\ (1)
:strong:`cdist-type__locale`\ (7)
AUTHORS AUTHORS
------- -------
Steven Armstrong <steven-cdist--@--armstrong.cc>, | Steven Armstrong <steven-cdist--@--armstrong.cc>
Carlos Ortigoza <carlos.ortigoza--@--ungleich.ch>, | Carlos Ortigoza <carlos.ortigoza--@--ungleich.ch>
Nico Schottelius <nico.schottelius--@--ungleich.ch> | Nico Schottelius <nico.schottelius--@--ungleich.ch>
COPYING COPYING

2
cdist/conf/type/__sysctl/man.rst
View file

@ -15,7 +15,7 @@ Runtime settings are set by directly calling the sysctl executable.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
value:: value
The value to set for the given key (object_id) The value to set for the given key (object_id)