Linux Documentation
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-doc@vger.kernel.org
Subject: [PATCH] docs: kdoc_output: only use out_tail when the identfier is shown
Date: Sat, 15 Aug 2026 22:48:26 -0700	[thread overview]
Message-ID: <20260816054826.3988516-1-rdunlap@infradead.org> (raw)

In -man mode, scripts/kernel-doc prints the "out_tail" information for
all symbols that are found (without the symbol info), whether the
symbols match the output selection criteria or not.

This can cause quite a lot of extraneous output in -man mode for the
symbols that are not in the selection criteria.

Modify kdoc_output.py so that it only calls out_tail() for symbols that
are being shown according to the selection criteria.

Closes: https://lore.kernel.org/all/fc7978bb-a71f-456d-84bb-670c8f0426ed@infradead.org/
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org

 tools/lib/python/kdoc/kdoc_output.py |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

--- linux-next-20260814.orig/tools/lib/python/kdoc/kdoc_output.py
+++ linux-next-20260814/tools/lib/python/kdoc/kdoc_output.py
@@ -198,22 +198,27 @@ class OutputFormat:
 
         if dtype == "function":
             self.out_function(fname, name, args)
+            self.out_tail(fname, name, args)
             return self.data
 
         if dtype == "enum":
             self.out_enum(fname, name, args)
+            self.out_tail(fname, name, args)
             return self.data
 
         if dtype == "var":
             self.out_var(fname, name, args)
+            self.out_tail(fname, name, args)
             return self.data
 
         if dtype == "typedef":
             self.out_typedef(fname, name, args)
+            self.out_tail(fname, name, args)
             return self.data
 
         if dtype in ["struct", "union"]:
             self.out_struct(fname, name, args)
+            self.out_tail(fname, name, args)
             return self.data
 
         # Warn if some type requires an output logic
@@ -763,7 +768,6 @@ class ManFormat(OutputFormat):
         Add a tail at the end of man pages output.
         """
         super().msg(fname, name, args)
-        self.out_tail(fname, name, args)
 
         return self.data
 

             reply	other threads:[~2026-08-16  6:12 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-16  5:48 Randy Dunlap [this message]
2026-08-16 18:05 ` [PATCH] docs: kdoc_output: only use out_tail when the identfier is shown Randy Dunlap
2026-08-17  5:41   ` Randy Dunlap

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260816054826.3988516-1-rdunlap@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.org \
    --cc=skhan@linuxfoundation.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox