Kconfig: Show include paths in menuconfig and documentation

Update Kconfiglib and menuconfig to upstream revision a28bc4da9762e,
which adds include path information to menuconfig, showing how the
Kconfig file of the symbol got 'source'd in addition to showing the
definition location.

Add include path information to the auto-generated Kconfig documentation
too.

Some small Kconfiglib bugs are fixed to, like error reporting for
recursive 'source's being broken (crashing instead of printing the
error), a minor file descriptor leak, and syntax checking not catching
extra trailing tokens after 'if <expr>' and 'depends on <expr>'.

Signed-off-by: Ulf Magnusson <[email protected]>

Author: ulfalizer

doc/scripts/genrest.py

@@ -90,12 +90,8 @@ def write_kconfig_rst():
     # String with the RST for the index page
     index_rst = INDEX_RST_HEADER
 
-    # - Sort the symbols by name so that they end up in sorted order in
-    #   index.rst
-    #
-    # - Use set() to get rid of duplicates for symbols defined in multiple
-    #   locations.
-    for sym in sorted(set(kconf.defined_syms), key=lambda sym: sym.name):
+    # Sort the symbols by name so that they end up in sorted order in index.rst
+    for sym in sorted(kconf.unique_defined_syms, key=lambda sym: sym.name):
         # Write an RST file for the symbol
         write_sym_rst(sym, out_dir)
 
@@ -107,7 +103,7 @@ def write_kconfig_rst():
             " / ".join(node.prompt[0]
                        for node in sym.nodes if node.prompt))
 
-    for choice in kconf.choices:
+    for choice in kconf.unique_choices:
         # Write an RST file for the choice
         write_choice_rst(choice, out_dir)
 
@@ -328,8 +324,21 @@ def add_selecting_implying_rst(type_str, expr):
 
 
 def kconfig_definition_rst(sc):
-    # Returns RST that lists the Kconfig definition(s) of 'sc' (symbol or
-    # choice)
+    # Returns RST that lists the Kconfig definition location, include path,
+    # menu path, and Kconfig definition for each node (definition location) of
+    # 'sc' (symbol or choice)
+
+    # Fancy Unicode arrow. Added in '93, so ought to be pretty safe.
+    arrow = " \N{RIGHTWARDS ARROW} "
+
+    def include_path(node):
+        if not node.include_path:
+            # In the top-level Kconfig file
+            return ""
+
+        return "Included via {}\n\n".format(
+            arrow.join("``{}:{}``".format(filename, linenr)
+                       for filename, linenr in node.include_path))
 
     def menu_path(node):
         path = ""
@@ -347,23 +356,30 @@ def menu_path(node):
             if node is node.kconfig.top_node:
                 break
 
-            # Fancy Unicode arrow. Added in '93, so ought to be pretty safe.
-            path = " → " + node.prompt[0] + path
+            path = arrow + node.prompt[0] + path
 
         return "(top menu)" + path
 
     heading = "Kconfig definition"
     if len(sc.nodes) > 1: heading += "s"
     rst = "{}\n{}\n\n".format(heading, len(heading)*"=")
 
-    rst += ".. highlight:: kconfig\n\n"
+    rst += ".. highlight:: kconfig"
 
-    rst += "\n\n".join(
-        "At ``{}:{}``, in menu ``{}``:\n\n"
-        ".. parsed-literal::\n\n"
-        "{}".format(node.filename, node.linenr, menu_path(node),
-                    textwrap.indent(node.custom_str(rst_link), " "*4))
-        for node in sc.nodes)
+    for node in sc.nodes:
+        rst += "\n\n" \
+               "At ``{}:{}``\n\n" \
+               "{}" \
+               "Menu path: {}\n\n" \
+               ".. parsed-literal::\n\n{}" \
+               .format(node.filename, node.linenr,
+                       include_path(node), menu_path(node),
+                       textwrap.indent(node.custom_str(rst_link), 4*" "))
+
+        # Not the last node?
+        if node is not sc.nodes[-1]:
+            # Add a horizontal line between multiple definitions
+            rst += "\n\n----"
 
     rst += "\n\n*(Definitions include propagated dependencies, " \
            "including from if's and menus.)*"