From c8cf1bbca4cf2577bbc2232ea0f8fcc5ea3625a9 Mon Sep 17 00:00:00 2001
From: JornVernee <jbvernee@xs4all.nl>
Date: Thu, 8 Nov 2018 19:27:20 +0100
Subject: [PATCH] Added missing has_documentation to MxCommand

changed to get_doc function, since that makes use simpler

commit right version this time :-)

Changed implementation to now return the doc correctly, test with `mx help unittest`

typo fix

Add command function doc to help message (accidentally removed it earlier)

- Only print <no documentation> if there is not usage_msg, doc string or doc function.
- Changed implementation slightly to make sure that doc is formatted correctly when some of these are missing
---
 mx.py          | 11 +----------
 mx_commands.py | 14 ++++++++++++++
 mx_unittest.py |  3 +--
 3 files changed, 16 insertions(+), 12 deletions(-)

diff --git a/mx.py b/mx.py
index e65759ea..c6cd4e3a 100755
--- a/mx.py
+++ b/mx.py
@@ -13679,16 +13679,7 @@ def help_(args):
             abort('mx: command \'{0}\' is ambiguous\n    {1}'.format(name, ' '.join(hits)))
 
     command = _mx_commands.commands()[name]
-    doc = command.command_function.__doc__
-    if command.has_documentation():
-        format_args = []
-        if command.usage_msg:
-            format_args.append(command.usage_msg)
-        if command.doc_function:
-            format_args.append(command.doc_function())
-
-        doc = doc.format(*format_args)
-    print 'mx {0} {1}\n\n{2}\n'.format(name, command.usage_msg, doc)
+    print command.get_doc()
 
 def _parse_multireleasejar_version(value):
     try:
diff --git a/mx_commands.py b/mx_commands.py
index ea60aec5..d436a89e 100644
--- a/mx_commands.py
+++ b/mx_commands.py
@@ -125,6 +125,20 @@ def __init__(self, mx_commands, command_function, suite_name, command, usage_msg
     def command_function(self):
         return self._command_function
 
+    def get_doc(self):
+        doc = 'mx {0} {1}'
+        msg = '<no documentation>'
+        if self.command_function.__doc__ or self.doc_function or self.usage_msg:
+            msg = ''
+            if self.usage_msg:
+                msg += self.usage_msg
+            if self.command_function.__doc__:
+                msg += '\n\n' + self.command_function.__doc__
+            if self.doc_function:
+                msg += '\n' + self.doc_function()
+
+        return doc.format(self.command, msg)
+
     def __call__(self, *args, **kwargs):
         for callback in self._mx_commands.command_before_callbacks:
             callback(self, *args, **kwargs)
diff --git a/mx_unittest.py b/mx_unittest.py
index cbb19bc3..72126e91 100755
--- a/mx_unittest.py
+++ b/mx_unittest.py
@@ -312,7 +312,6 @@ def _run_vm(vmArgs, mainClass, mainClassArgs):
             os.remove(testfile)
 
 unittestHelpSuffix = """
-
     To avoid conflicts with VM options '--' can be used as delimiter.
 
     If test filters are supplied, only tests whose fully qualified name
@@ -351,7 +350,7 @@ def is_strictly_positive(value):
 @mx.command(suite_name="mx",
             command_name='unittest',
             usage_msg='[unittest options] [--] [VM options] [filters...]',
-            doc_function=unittestHelpSuffix,
+            doc_function=lambda: unittestHelpSuffix,
             auto_add=False)
 def unittest(args):
     """run the JUnit tests"""