valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 08:58:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improving docs for salt.states.makeconf

Browse Source
This commit is contained in:
Nitin Madhok 2014-07-08 12:57:49 -04:00
parent fef51d34ef
commit 51bea3c8b0
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
salt/states/makeconf.py
View File

@ -3,13 +3,13 @@
Management of Gentoo make.conf
==============================
A state module to manage Gentoo's make.conf file
A state module to manage Gentoo's ``make.conf`` file
.. code-block:: yaml
makeopts:
makeconf.present:
- value: '-j3'
makeconf.present:
- value: '-j3'
'''
@ -36,12 +36,12 @@ def _make_set(var):
def present(name, value=None, contains=None, excludes=None):
'''
Verify that the variable is in the make.conf and has the provided
Verify that the variable is in the ``make.conf`` and has the provided
settings. If value is set, contains and excludes will be ignored.
name
The variable name. This will automatically be converted to all Upper
Case since variables in make.conf are Upper Case
The variable name. This will automatically be converted to upper
case since variables in ``make.conf`` are in upper case
value
Enforce that the value of the variable is set to the provided value
@ -160,11 +160,11 @@ def present(name, value=None, contains=None, excludes=None):
def absent(name):
'''
Verify that the variable is not in the make.conf.
Verify that the variable is not in the ``make.conf``.
name
The variable name. This will automatically be converted to all Upper
Case since variables in make.conf are Upper Case
The variable name. This will automatically be converted to upper
case since variables in ``make.conf`` are in upper case
'''
ret = {'changes': {},
'comment': '',