Linux Documentation
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Linux Documentation <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: kernel-doc -man -e confusion
Date: Sat, 8 Aug 2026 22:23:15 -0700	[thread overview]
Message-ID: <fc7978bb-a71f-456d-84bb-670c8f0426ed@infradead.org> (raw)

[-- Attachment #1: Type: text/plain, Size: 807 bytes --]

Hi Mauro,

(testing with linux-next-20260807:)

When I run
$ ./scripts/kernel-doc -man -e include/rdma/ib_mad.h
(this header file has no exported symbols),

it appears that kdoc_output.py::out_tail() is called for
each non-exported symbol. This looks extraneous to me.

Can you fix this so that out_tail() isn't called for the
non-exported symbols?

Secondary comment: I save the kernel-doc -man output to
ibmadexp.man and then run
$ man ./ibmadexp.man
(which is attached)

where I see the out_tail() output, **except** that the
SEE ALSO: line isn't printed (displayed) by the man command.
Is there a problem with the generated line
.SH "SEE ALSO"
?
Maybe it needs a blank line before it or some other kind of
formatting assistance or something around it is confusing the
'man' command?

thanks.
-- 
~Randy

[-- Attachment #2: ibmadexp.man --]
[-- Type: application/x-troff-man, Size: 14822 bytes --]

                 reply	other threads:[~2026-08-09  5:23 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

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=fc7978bb-a71f-456d-84bb-670c8f0426ed@infradead.org \
    --to=rdunlap@infradead.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=mchehab@kernel.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