From 7e608db3e5d93d81714bb61272be34302c92ea4c Mon Sep 17 00:00:00 2001
From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com>
Date: Wed, 8 Mar 2023 15:19:51 +0100
Subject: [PATCH] [PR #6161/6d003ca7 backport][stable-5] [make] Improve module
 doc (#6162)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

[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.

(cherry picked from commit 6d003ca7fcb0bca3cddb93d80de9cced26452803)

Co-authored-by: Cédric Jeanneret <39397510+cjeanner@users.noreply.github.com>
---
 plugins/modules/system/make.py | 56 +++++++++++++++++++++++++---------
 1 file changed, 41 insertions(+), 15 deletions(-)

diff --git a/plugins/modules/system/make.py b/plugins/modules/system/make.py
index 31da07c579..9758c4e60b 100644
--- a/plugins/modules/system/make.py
+++ b/plugins/modules/system/make.py
@@ -18,15 +18,6 @@ author: Linus Unnebäck (@LinusU) <linus@folkdatorn.se>
 description:
   - Run targets in a Makefile.
 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:
     description:
       - Change to this directory before running make.
@@ -36,11 +27,6 @@ options:
     description:
       - Use a custom Makefile.
     type: path
-  make:
-    description:
-      - Use a specific make binary.
-    type: path
-    version_added: '0.2.0'
   jobs:
     description:
       - Set the number of make jobs to run concurrently.
@@ -48,6 +34,20 @@ options:
       - This is not supported by all make implementations.
     type: int
     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'''
@@ -76,7 +76,33 @@ EXAMPLES = r'''
     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.basic import AnsibleModule