1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

Docs: Cleanup make module docs (#46422)

Signed-off-by: Major Hayden <major@redhat.com>
This commit is contained in:
Major Hayden 2018-10-03 15:12:07 -05:00 committed by Sandra McCann
parent d6a581502f
commit b6568c1c75

View file

@ -25,41 +25,42 @@ description:
options: options:
target: target:
description: description:
- The target to run - The target to run.
- "Examples: C(install) or C(test)"
params: params:
description: description:
- Any extra parameters to pass to make - Any extra parameters to pass to make
chdir: chdir:
description: description:
- cd into this directory before running make - Change to this directory before running make
required: true required: true
file: file:
description: description:
- Use file as a Makefile - Use a custom Makefile
version_added: 2.5 version_added: 2.5
''' '''
EXAMPLES = ''' EXAMPLES = '''
# Build the default target - name: Build the default target
- make: make:
chdir: /home/ubuntu/cool-project chdir: /home/ubuntu/cool-project
# Run `install` target as root - name: Run 'install' target as root
- make: make:
chdir: /home/ubuntu/cool-project chdir: /home/ubuntu/cool-project
target: install target: install
become: yes become: yes
# Pass in extra arguments to build - name: Build 'all' target with extra arguments
- make: make:
chdir: /home/ubuntu/cool-project chdir: /home/ubuntu/cool-project
target: all target: all
params: params:
NUM_THREADS: 4 NUM_THREADS: 4
BACKEND: lapack BACKEND: lapack
# Pass a file as a Makefile - name: Build 'all' target with a custom Makefile
- make: make:
chdir: /home/ubuntu/cool-project chdir: /home/ubuntu/cool-project
target: all target: all
file: /some-project/Makefile file: /some-project/Makefile