From: Jonathan Corbet <corbet@lwn.net>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: Mike Rapoport <rppt@linux.vnet.ibm.com>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] scripts: kernel_doc: fixup reporting of function identifiers
Date: Sun, 18 Feb 2018 16:48:05 -0700 [thread overview]
Message-ID: <20180218164805.2cf46459@lwn.net> (raw)
In-Reply-To: <17062CC8-55BF-423B-A4F5-726291417D21@darmarit.de>
On Fri, 16 Feb 2018 17:36:07 +0100
Markus Heiser <markus.heiser@darmarit.de> wrote:
> > So let me channel akpm here and ask: what are the user-visible effects of
> > this problem? I ask because applying it doesn't make any difference in
> > the "make htmldocs" output here. So I don't understand why you're
> > wanting to make this change.
>
> Use kernel-doc -v and take a look on the info-messages.
>
> In Documentation/doc-guide/kernel-doc we recommend to use
>
> /**
> * foo() - lorem ipsum
>
> to tag functions, but if you do so, the info message is broken,
> the function name is missed at the end of the message:
>
> ../test123.c:2: info: Scanning doc for
OK, so I guess that message is the only effect of this bug. Oh well,
I'll go ahead and apply the patch, thanks.
jon
prev parent reply other threads:[~2018-02-18 23:48 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-13 11:31 [PATCH] scripts: kernel_doc: fixup reporting of function identifiers Mike Rapoport
2018-02-16 14:56 ` Jonathan Corbet
2018-02-16 16:36 ` Markus Heiser
2018-02-18 23:48 ` Jonathan Corbet [this message]
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=20180218164805.2cf46459@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=rppt@linux.vnet.ibm.com \
/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