From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Linux Media Mailing List <linux-media@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH v3 00/17] kernel-doc: add supported to document nested structs/
Date: Mon, 18 Dec 2017 13:26:11 -0200 [thread overview]
Message-ID: <20171218132611.2898a42b@vento.lan> (raw)
In-Reply-To: <cover.1507116877.git.mchehab@s-opensource.com>
Em Wed, 4 Oct 2017 08:48:38 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> escreveu:
> Right now, it is not possible to document nested struct and nested unions.
> kernel-doc simply ignore them.
>
> Add support to document them.
>
> Patches 1 to 6 improve kernel-doc documentation to reflect what
> kernel-doc currently supports and import some stuff from the
> old kernel-doc-nano-HOWTO.txt.
>
> Patch 7 gets rid of the old documentation (kernel-doc-nano-HOWTO.txt).
>
>
> Patch 8 gets rid of the now unused output formats for kernel-doc: since
> we got rid of all DocBook stuff, we should not need them anymore. The
> reason for dropping it (despite cleaning up), is that it doesn't make
> sense to invest time on adding new features for formats that aren't
> used anymore.
>
> Patch 9 improves argument handling, printing script usage if an
> invalid argument is passed and accepting both -cmd and --cmd
> forms.
>
> Patch 10 changes the default output format to ReST, as this is a way
> more used than man output nowadays.
>
> Patch 11 solves an issue after ReST conversion, where tabs were not
> properly handled on kernel-doc tags.
>
> Patch 12 adds support for parsing kernel-doc nested structures and
> unions.
>
> Patch 13 does a cleanup, removing $nexted parameter at the
> routines that handle structs.
>
> Patch 14 Improves warning output by printing the identifier where
> the warning occurred.
>
> Patch 15 complements patch 12, by adding support for function
> definitions inside nested structures. It is needed by some media
> docs with use such kind of things.
>
> Patch 16 improves nested struct handling even further, allowing it
> to handle cases where a nested named struct/enum with multiple
> identifiers added (e. g. struct { ... } foo, bar;).
>
> Patch 17 adds documentation for nested union/struct inside w1_netlink.
>
> The entire patch series are at my development tree, at:
> https://git.linuxtv.org/mchehab/experimental.git/log/?h=nested-fix-v4b
I'm applying all patches from this series that either didn't have
any comments of whose editorial comments I fully embraced.
The patches that weren't applied from this series are:
0008-media-v4l2-device.h-document-ancillary-macros.patch
0010-media-v4l2-ioctl.h-convert-debug-macros-into-enum-an.patch
0014-media-v4l2-async-simplify-v4l2_async_subdev-structur.patch
0015-media-v4l2-async-better-describe-match-union-at-asyn.patch
I'll send later a patch series with those - probably together with
other documentation patches from the other two series I sent - that
need further reviews.
Thanks,
Mauro
prev parent reply other threads:[~2017-12-18 15:26 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-04 11:48 Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 01/17] docs: kernel-doc.rst: better describe kernel-doc arguments Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 02/17] docs: kernel-doc.rst: improve private members description Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 03/17] docs: kernel-doc.rst: improve function documentation section Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 04/17] docs: kernel-doc.rst: improve structs chapter Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 05/17] docs: kernel-doc.rst: improve typedef documentation Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 06/17] docs: kernel-doc.rst: add documentation about man pages Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 07/17] docs: get rid of kernel-doc-nano-HOWTO.txt Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 08/17] scripts: kernel-doc: get rid of unused output formats Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 09/17] scripts: kernel-doc: improve argument handling Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 10/17] scripts: kernel-doc: change default to ReST format Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 11/17] scripts: kernel-doc: replace tabs by spaces Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 12/17] scripts: kernel-doc: parse next structs/unions Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 13/17] scripts: kernel-doc: get rid of $nested parameter Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 14/17] scripts: kernel-doc: print the declaration name on warnings Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 15/17] scripts: kernel-doc: handle nested struct function arguments Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 16/17] scripts: kernel-doc: improve nested logic to handle multiple identifiers Mauro Carvalho Chehab
2017-10-04 11:48 ` [PATCH v3 17/17] w1_netlink.h: add support for nested structs Mauro Carvalho Chehab
2017-10-07 16:34 ` [PATCH v3 00/17] kernel-doc: add supported to document nested structs/ Jonathan Corbet
2017-10-08 10:07 ` Markus Heiser
2017-10-09 13:19 ` Mauro Carvalho Chehab
2017-10-11 19:17 ` Mauro Carvalho Chehab
2017-12-18 15:26 ` Mauro Carvalho Chehab [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=20171218132611.2898a42b@vento.lan \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--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
Powered by JetHome