From b6568c1c7587af82eafeed9d30e61cd742c8ae45 Mon Sep 17 00:00:00 2001 From: Major Hayden Date: Wed, 3 Oct 2018 15:12:07 -0500 Subject: [PATCH] Docs: Cleanup make module docs (#46422) Signed-off-by: Major Hayden --- lib/ansible/modules/system/make.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/lib/ansible/modules/system/make.py b/lib/ansible/modules/system/make.py index c1e6dc2682..92d90be66a 100644 --- a/lib/ansible/modules/system/make.py +++ b/lib/ansible/modules/system/make.py @@ -25,41 +25,42 @@ description: options: target: description: - - The target to run + - The target to run. + - "Examples: C(install) or C(test)" params: description: - Any extra parameters to pass to make chdir: description: - - cd into this directory before running make + - Change to this directory before running make required: true file: description: - - Use file as a Makefile + - Use a custom Makefile version_added: 2.5 ''' EXAMPLES = ''' -# Build the default target -- make: +- name: Build the default target + make: chdir: /home/ubuntu/cool-project -# Run `install` target as root -- make: +- name: Run 'install' target as root + make: chdir: /home/ubuntu/cool-project target: install become: yes -# Pass in extra arguments to build -- make: +- name: Build 'all' target with extra arguments + make: chdir: /home/ubuntu/cool-project target: all params: NUM_THREADS: 4 BACKEND: lapack -# Pass a file as a Makefile -- make: +- name: Build 'all' target with a custom Makefile + make: chdir: /home/ubuntu/cool-project target: all file: /some-project/Makefile