[make] Improve module doc (#6161)
This change reorder the parameters so that we get the mandatory one at the top, then alphabetically order the other bellow. It also adds the returned values.pull/6166/head
parent
6cf674485f
commit
6d003ca7fc
|
@ -25,15 +25,6 @@ attributes:
|
||||||
diff_mode:
|
diff_mode:
|
||||||
support: none
|
support: none
|
||||||
options:
|
options:
|
||||||
target:
|
|
||||||
description:
|
|
||||||
- The target to run.
|
|
||||||
- Typically this would be something like C(install),C(test) or C(all)."
|
|
||||||
type: str
|
|
||||||
params:
|
|
||||||
description:
|
|
||||||
- Any extra parameters to pass to make.
|
|
||||||
type: dict
|
|
||||||
chdir:
|
chdir:
|
||||||
description:
|
description:
|
||||||
- Change to this directory before running make.
|
- Change to this directory before running make.
|
||||||
|
@ -43,11 +34,6 @@ options:
|
||||||
description:
|
description:
|
||||||
- Use a custom Makefile.
|
- Use a custom Makefile.
|
||||||
type: path
|
type: path
|
||||||
make:
|
|
||||||
description:
|
|
||||||
- Use a specific make binary.
|
|
||||||
type: path
|
|
||||||
version_added: '0.2.0'
|
|
||||||
jobs:
|
jobs:
|
||||||
description:
|
description:
|
||||||
- Set the number of make jobs to run concurrently.
|
- Set the number of make jobs to run concurrently.
|
||||||
|
@ -55,6 +41,20 @@ options:
|
||||||
- This is not supported by all make implementations.
|
- This is not supported by all make implementations.
|
||||||
type: int
|
type: int
|
||||||
version_added: 2.0.0
|
version_added: 2.0.0
|
||||||
|
make:
|
||||||
|
description:
|
||||||
|
- Use a specific make binary.
|
||||||
|
type: path
|
||||||
|
version_added: '0.2.0'
|
||||||
|
params:
|
||||||
|
description:
|
||||||
|
- Any extra parameters to pass to make.
|
||||||
|
type: dict
|
||||||
|
target:
|
||||||
|
description:
|
||||||
|
- The target to run.
|
||||||
|
- Typically this would be something like C(install), C(test), or C(all).
|
||||||
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = r'''
|
EXAMPLES = r'''
|
||||||
|
@ -83,7 +83,33 @@ EXAMPLES = r'''
|
||||||
file: /some-project/Makefile
|
file: /some-project/Makefile
|
||||||
'''
|
'''
|
||||||
|
|
||||||
RETURN = r'''# '''
|
RETURN = r'''
|
||||||
|
chdir:
|
||||||
|
description:
|
||||||
|
- The value of the module parameter I(chdir).
|
||||||
|
type: str
|
||||||
|
returned: success
|
||||||
|
file:
|
||||||
|
description:
|
||||||
|
- The value of the module parameter I(file).
|
||||||
|
type: str
|
||||||
|
returned: success
|
||||||
|
jobs:
|
||||||
|
description:
|
||||||
|
- The value of the module parameter I(jobs)
|
||||||
|
type: int
|
||||||
|
returned: success
|
||||||
|
params:
|
||||||
|
description:
|
||||||
|
- The value of the module parameter I(params)
|
||||||
|
type: dict
|
||||||
|
returned: success
|
||||||
|
target:
|
||||||
|
description:
|
||||||
|
- The value of the module parameter I(target)
|
||||||
|
type: str
|
||||||
|
returned: success
|
||||||
|
'''
|
||||||
|
|
||||||
from ansible.module_utils.six import iteritems
|
from ansible.module_utils.six import iteritems
|
||||||
from ansible.module_utils.basic import AnsibleModule
|
from ansible.module_utils.basic import AnsibleModule
|
||||||
|
|
Loading…
Reference in New Issue