The Documentation/ABI/README file is currently outside the
documentation tree. Yet, it may still provide some useful
information. Add it to the documentation parsing.
As a plus, this avoids a warning when detecting missing
cross-references.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
scripts/lib/abi/abi_parser.py | 25 ++++++++++++++++++++-----
1 file changed, 20 insertions(+), 5 deletions(-)
diff --git a/scripts/lib/abi/abi_parser.py b/scripts/lib/abi/abi_parser.py
index b20d5c9d920e..6fac461d794c 100644
--- a/scripts/lib/abi/abi_parser.py
+++ b/scripts/lib/abi/abi_parser.py
@@ -263,6 +263,16 @@ class AbiParser:
if content:
self.warn(fdata, "Unexpected content", line)
+ def parse_readme(self, nametag, fname):
+ """Parse ABI README file"""
+
+ with open(fname, "r", encoding="utf8", errors="backslashreplace") as fp:
+ nametag["description"] = "```\n"
+ for line in fp:
+ nametag["description"] += " " + line
+
+ nametag["description"] += "```\n"
+
def parse_file(self, fname, path, basename):
"""Parse a single file"""
@@ -309,6 +319,10 @@ class AbiParser:
if self.debug & AbiDebug.WHAT_OPEN:
self.log.debug("Opening file %s", fname)
+ if basename == "README":
+ self.parse_readme(fdata.nametag, fname)
+ return
+
with open(fname, "r", encoding="utf8", errors="backslashreplace") as fp:
for line in fp:
fdata.ln += 1
@@ -344,9 +358,6 @@ class AbiParser:
basename = os.path.basename(name)
- if basename == "README":
- continue
-
if basename.startswith("."):
continue
@@ -448,8 +459,12 @@ class AbiParser:
continue
if filter_path:
- if v.get("path") != filter_path:
- continue
+ if filter_path == "README":
+ if not names[0].endswith("README"):
+ continue
+ else:
+ if v.get("path") != filter_path:
+ continue
msg = ""
--
2.48.1
