doc-rst: reST-directive kernel-cmd parse with tabs

Commit Message

Markus Heiser Oct. 18, 2016, 5:19 p.m. UTC

Add a 'tab-width' option to the kernel-cmd, and convert
whitespace (tabs) well. The default 'tab-width' is 8.  This is also a
bugfix, since without this patch, tabs in command's output are not
handled.

Signed-off-by: Markus Heiser <[e-mail]>
---
 Documentation/sphinx/kernel_cmd.py | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

Patch

diff --git a/Documentation/sphinx/kernel_cmd.py b/Documentation/sphinx/kernel_cmd.py
index 43f02b0..bbe8fa9 100644
--- a/Documentation/sphinx/kernel_cmd.py
+++ b/Documentation/sphinx/kernel_cmd.py
@@ -27,6 +27,10 @@  u"""
 
         PATH=$(srctree)/scripts:$(srctree)/Documentation/sphinx:...
 
+    ``tab-width``
+
+      Tabulator width of output, default is 8.
+
     ``depends <list of comma separated file names>``
 
       If the stdout of the command line depends on files, you can add them as
@@ -70,7 +74,7 @@  from sphinx.ext.autodoc import AutodocReporter
 
 from docutils import nodes
 from docutils.parsers.rst import Directive, directives
-from docutils.statemachine import ViewList
+from docutils import statemachine
 from docutils.utils.error_reporting import ErrorString
 
 
@@ -105,7 +109,8 @@  class KernelCmd(Directive):
     option_spec = {
         "depends"   : directives.unchanged,
         "code-block": directives.unchanged,
-        "debug"     : directives.flag
+        "debug"     : directives.flag,
+        "tab-width" : directives.nonnegative_int
     }
 
     def warn(self, message, **replace):
@@ -148,6 +153,7 @@  class KernelCmd(Directive):
         shell_env["srctree"] = srctree
 
         lines = self.runCmd(cmd, shell=True, cwd=cwd, env=shell_env)
+
         nodeList = self.nestedParse(lines, fname)
         return nodeList
 
@@ -176,7 +182,7 @@  class KernelCmd(Directive):
         return unicode(out)
 
     def nestedParse(self, lines, fname):
-        content = ViewList()
+        content = statemachine.ViewList()
         node    = nodes.section()
 
         if "code-block" in self.options:
@@ -191,7 +197,10 @@  class KernelCmd(Directive):
                 code_block += "\n    " + l
             lines = code_block + "\n\n"
 
-        for c, l in enumerate(lines.split("\n")):
+        tab_width = self.options.get('tab-width', 8)
+        lines = statemachine.string2lines(lines, tab_width, convert_whitespace=True)
+
+        for c, l in enumerate(lines):
             content.append(l, fname, c)
 
         buf  = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter