Added TODOs for bugs left unaddressed in the last commit

Author: David Noble

examples/searchcommands_scaffolding/default/commands.conf

@@ -1,6 +1,6 @@
 # [commands.conf]($SPLUNK_HOME/etc/system/README/commands.conf.spec)
 [defaults]
-supports_getinfo = true
 
 [%(command.lower()]
 filename = %(command.lower()).py
+supports_getinfo = true

setup.py

@@ -57,6 +57,7 @@ def run(self):
         cov.stop()
         cov.html_report(directory='coverage_report')
 
+
 class TestCommand(Command):
     """setup.py command to run the whole test suite."""
     description = "Run test full test suite."

splunklib/searchcommands/__init__.py

@@ -133,6 +133,14 @@ class sets this value unconditionally. You cannot override it.
 2. [Search command style guide](http://docs.splunk.com/Documentation/Splunk/6.0/Search/Searchcommandstyleguide)
 
 """
+
+# TODO: Do not use [defaults] stanza in commands.conf
+# It doesn't work as advertised. Make sure the ERD/PRD/User documentation is
+# updated. The source code already is.
+
+# TODO: Multi-line message headers are incorrectly formatted in Splunk Web UI
+# What should we be using as a newline terminator? Try url encoding.
+
 from __future__ import absolute_import
 
 from .decorators import *

splunklib/searchcommands/search_command.py

@@ -184,10 +184,9 @@ def process(self, args=argv, input_file=stdin, output_file=stdout):
             message = (
                 'Static configuration is unsupported. Please configure this '
                 'command as follows in default/commands.conf:\n\n'
-                '[default]\n'
-                'supports_getinfo = true\n'
                 '[%s]\n'
-                'filename = %s' %
+                'filename = %s\n' %
+                'supports_getinfo = true'
                 (type(self).name, path.basename(argv[0])))
             self.messages.append('error_message', message)
             self.messages.write(output_file)