linux-media.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Media Mailing List <linux-media@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org, Evgeniy Polyakov <zbr@ioremap.net>,
	Daniel Vetter <daniel.vetter@ffwll.ch>
Subject: [PATCH 00/10] kernel-doc: add supported to document nested structs/unions
Date: Tue, 26 Sep 2017 14:59:10 -0300	[thread overview]
Message-ID: <cover.1506448061.git.mchehab@s-opensource.com> (raw)

Right now, it is not possible to document nested struct and nested unions.
kernel-doc simply ignore them.

Add support to document them.

This series starts with a patch getting 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.

The next 8 patches on this series improve kernel-doc documentation and
finally get rid of its old documentation (kernel-doc-nano-HOWTO.txt).

Patch 9/10 is the most interesting one in this series: it adds support for
nested structures and unions.

Patch 10/10 is just an example from a random header with kernel-doc
markups. There's no special reason for selecting this file, and the
comments there are likely wrong. So, please use it only as a way to test
the new parser logic from patch 9/10.

Mauro Carvalho Chehab (10):
  scripts: kernel-doc: get rid of unused output formats
  docs: kernel-doc.rst: better describe kernel-doc arguments
  docs: kernel-doc.rst: improve private members description
  docs: kernel-doc.rst: improve function documentation section
  docs: kernel-doc.rst: improve structs chapter
  docs: kernel-doc: improve typedef documentation
  docs: kernel-doc.rst: add documentation about man pages
  docs: get rid of kernel-doc-nano-HOWTO.txt
  scripts: kernel-doc: parse next structs/unions
  [RFC] w1_netlink.h: add support for nested structs

---

Before this series, I send a few PoC patches. They were all
replaced by patch 9/10.

 Documentation/00-INDEX                  |    2 -
 Documentation/doc-guide/kernel-doc.rst  |  387 ++++++---
 Documentation/kernel-doc-nano-HOWTO.txt |  322 --------
 drivers/w1/w1_netlink.h                 |    4 +
 scripts/kernel-doc                      | 1304 ++-----------------------------
 5 files changed, 346 insertions(+), 1673 deletions(-)
 delete mode 100644 Documentation/kernel-doc-nano-HOWTO.txt

-- 
2.13.5

             reply	other threads:[~2017-09-26 17:59 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-26 17:59 Mauro Carvalho Chehab [this message]
2017-09-26 17:59 ` [PATCH 01/10] scripts: kernel-doc: get rid of unused output formats Mauro Carvalho Chehab
2017-09-27 14:36   ` Jani Nikula
2017-09-27 20:41     ` Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 02/10] docs: kernel-doc.rst: better describe kernel-doc arguments Mauro Carvalho Chehab
2017-09-27  2:04   ` Randy Dunlap
2017-09-26 17:59 ` [PATCH 03/10] docs: kernel-doc.rst: improve private members description Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 04/10] docs: kernel-doc.rst: improve function documentation section Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 05/10] docs: kernel-doc.rst: improve structs chapter Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 06/10] docs: kernel-doc: improve typedef documentation Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 07/10] docs: kernel-doc.rst: add documentation about man pages Mauro Carvalho Chehab
2017-09-27  2:07   ` Randy Dunlap
2017-09-26 17:59 ` [PATCH 08/10] docs: get rid of kernel-doc-nano-HOWTO.txt Mauro Carvalho Chehab
2017-09-26 17:59 ` [PATCH 09/10] scripts: kernel-doc: parse next structs/unions Mauro Carvalho Chehab
2017-09-26 20:29   ` Mauro Carvalho Chehab
2017-09-26 20:41     ` Jonathan Corbet
2017-09-26 17:59 ` [PATCH 10/10] [RFC] w1_netlink.h: add support for nested structs Mauro Carvalho Chehab
2017-10-01  5:57   ` Evgeniy Polyakov

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=cover.1506448061.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=daniel.vetter@ffwll.ch \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-media@vger.kernel.org \
    --cc=mchehab@infradead.org \
    --cc=zbr@ioremap.net \
    /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).