From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Markus Heiser <markus.heiser@darmarit.de>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
LKML <linux-kernel@vger.kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
Jani Nikula <jani.nikula@intel.com>
Subject: Re: [PATCH 4/6] scripts: kernel-doc: support in-line comments on nested structs/unions
Date: Fri, 16 Feb 2018 12:56:51 -0200 [thread overview]
Message-ID: <20180216125651.45401575@vento.lan> (raw)
In-Reply-To: <54EF06CB-C31F-476D-B674-579E9385D635@darmarit.de>
Em Fri, 16 Feb 2018 15:52:33 +0100
Markus Heiser <markus.heiser@darmarit.de> escreveu:
> > Am 16.02.2018 um 14:48 schrieb Mauro Carvalho Chehab <mchehab@s-opensource.com>:
> >
> > The parser at kernel-doc rejects names with dots in the middle.
> > Fix it, in order to support nested structs/unions.
> >
> > Tested-by: Jani Nikula <jani.nikula@intel.com>
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > ---
> > scripts/kernel-doc | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> > index fee8952037b1..06d7f3f2c094 100755
> > --- a/scripts/kernel-doc
> > +++ b/scripts/kernel-doc
> > @@ -363,7 +363,7 @@ my $doc_sect = $doc_com .
> > my $doc_content = $doc_com_body . '(.*)';
> > my $doc_block = $doc_com . 'DOC:\s*(.*)?';
> > my $doc_inline_start = '^\s*/\*\*\s*$';
> > -my $doc_inline_sect = '\s*\*\s*(@[\w\s]+):(.*)';
> > +my $doc_inline_sect = '\s*\*\s*(@\s*[\w][\w\.]*\s*):(.*)';
>
> Thanks!
>
> FWIW: added similar patch to python variant of kernel-doc:
>
> https://github.com/return42/linuxdoc/commit/5c5da9a
>
> rendered example:
>
> https://return42.github.io/linuxdoc/linuxdoc-howto/all-in-a-tumble.html#struct-my-long-struct
On a quick look, on your example, bar2.barbar description looks different
than what we get from the perl version.
There, it generates it as:
``bar2.barbar``
Description for **barbar** inside **foo.bar2**
Regards,
Mauro
next prev parent reply other threads:[~2018-02-16 14:57 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-16 13:48 [PATCH 0/6] Add support for in-line nested struct comments Mauro Carvalho Chehab
2018-02-16 13:48 ` [PATCH 1/6] doc-guide: kernel-doc: fix example for nested_foobar struct Mauro Carvalho Chehab
2018-02-16 13:48 ` [PATCH 2/6] doc-guide: kernel-doc: fix example for inlined comments Mauro Carvalho Chehab
2018-02-16 13:48 ` [PATCH 3/6] doc-guide: kernel-doc: move in-line section to be after nested struct Mauro Carvalho Chehab
2018-02-16 13:48 ` [PATCH 4/6] scripts: kernel-doc: support in-line comments on nested structs/unions Mauro Carvalho Chehab
2018-02-16 14:52 ` Markus Heiser
2018-02-16 14:56 ` Mauro Carvalho Chehab [this message]
2018-02-16 16:11 ` Markus Heiser
2018-02-16 13:48 ` [PATCH 5/6] doc-guide: kernel-doc: add examples about nested union/structs Mauro Carvalho Chehab
2018-02-16 13:48 ` [PATCH 6/6] drm: intel_dpio_phy: fix kernel-doc comments at nested struct Mauro Carvalho Chehab
2018-02-19 0:03 ` [PATCH 0/6] Add support for in-line nested struct comments Jonathan Corbet
2018-02-19 10:05 ` Jani Nikula
2018-02-19 15:39 ` [Intel-gfx] " Daniel Vetter
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=20180216125651.45401575@vento.lan \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=jani.nikula@intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.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;
as well as URLs for NNTP newsgroup(s).