Skip to contentSkip to conversation

fixes for maintainers_include

PATCH Applied Mauro Carvalho Chehab 2 participants 3 messages Jul 12 – Jul 16

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

v2 cover fixes for maintainers_include

Hi Jon,

This v2 replaces v1 series:
[PATCH 0/2] A couple of fixes for maintainers_include.py

It basically fixes an issue reported by Manuel that entries are printed duplicated.

In reality, the output maintainer entries are not properly named per subsystem, so they appear to be duplicated.

Fixing the name output solves the issue and keeps the list alphabetically sorted, as expected.

Mauro Carvalho Chehab (1):
docs: maintainers_include: fix entry names

 Documentation/sphinx/maintainers_include.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Signature · 1 line
2.55.0
#1 lore raw

PATCH v2 1/1 docs: maintainers_include: fix entry names

Right now, it is printing duplicated values as profile entries, as it is not properly handling subsystem name.

Fix it.

---
 Documentation/sphinx/maintainers_include.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
Documentation/sphinx/maintainers_include.py +5 -2
index dc9f9e188ffa..7ffe19b5ed58 100755
@@ -161,7 +161,7 @@ class MaintainersParser:
                     html = KERNELDOC_URL + ename + ".html"
                     entries[entry] = f'`{ename} <{html}>`_'
                 else:
-                    entries[entry] = f':doc:`{ename} </{entry}>`'
+                    entries[entry] = f'/{entry}'
 
         return entries
 
@@ -345,7 +345,10 @@ class MaintainersProfile(Include):
                 output += f"- {name}: {entry}\n"
                 self.warning(f"{profile}: Invalid 'P' tag: {entry}\n")
             else:
-                output += f"- {entry}\n"
+                if not name:
+                    name = entry
+
+                output += f"- :doc:`{name} <{entry}>`\n"
 
         #
         # Create a hidden TOC table with all profiles. That allows adding
Signature · 1 line
2.55.0
maintainer Applied
#2 lore raw

Re: [PATCH v2 1/1] docs: maintainers_include: fix entry names

Quoted 11 lines · Mauro Carvalho Chehab

Right now, it is printing duplicated values as profile entries, as it is not properly handling subsystem name.

Fix it.

---
 Documentation/sphinx/maintainers_include.py | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Applied, thanks.

jon