devicetree.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Rob Herring <robh@kernel.org>
To: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
	Frank Rowand <frowand.list@gmail.com>,
	Lee Jones <lee.jones@linaro.org>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Subject: [PATCH 0/8] dt: doc build improvements and kerneldoc addition
Date: Thu, 25 Mar 2021 10:47:05 -0600	[thread overview]
Message-ID: <20210325164713.1296407-1-robh@kernel.org> (raw)

This series reorganizes the DT documentation and adds the DT API
kerneldoc to the documentation build.

It's based on the current DT for-next branch which has a series of
kerneldoc fixes from Lee Jones.

Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Lee Jones <lee.jones@linaro.org>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org

Rob Herring (8):
  dt-bindings: Fix reference in submitting-patches.rst to the DT ABI doc
  docs: dt: writing-schema: Remove spurious indentation
  docs: dt: writing-schema: Include the example schema in the doc build
  docs: dt: Make 'Devicetree' wording more consistent
  docs: dt: Group DT docs into relevant sub-sections
  of: Fix kerneldoc output formatting
  of: Add missing 'Return' section in kerneldoc comments
  docs: dt: Add DT API documentation

 Documentation/devicetree/bindings/index.rst   |   7 +-
 .../bindings/submitting-patches.rst           |   4 +-
 .../{ => bindings}/writing-schema.rst         |  17 +-
 Documentation/devicetree/changesets.rst       |   8 +-
 .../devicetree/dynamic-resolution-notes.rst   |   8 +-
 Documentation/devicetree/index.rst            |  19 +-
 Documentation/devicetree/kernel-api.rst       |  57 ++++
 Documentation/devicetree/of_unittest.rst      |   6 +-
 Documentation/devicetree/overlay-notes.rst    |   8 +-
 Documentation/devicetree/usage-model.rst      |   8 +-
 drivers/of/base.c                             | 323 +++++++++---------
 drivers/of/dynamic.c                          |  19 +-
 drivers/of/fdt.c                              |  17 +-
 drivers/of/irq.c                              |  14 +-
 drivers/of/overlay.c                          |  16 +-
 drivers/of/platform.c                         |  10 +-
 drivers/of/property.c                         |  66 ++--
 include/linux/of.h                            |  63 ++--
 18 files changed, 395 insertions(+), 275 deletions(-)
 rename Documentation/devicetree/{ => bindings}/writing-schema.rst (95%)
 create mode 100644 Documentation/devicetree/kernel-api.rst

-- 
2.27.0


             reply	other threads:[~2021-03-25 16:48 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-25 16:47 Rob Herring [this message]
2021-03-25 16:47 ` [PATCH 1/8] dt-bindings: Fix reference in submitting-patches.rst to the DT ABI doc Rob Herring
2021-03-25 17:51   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 2/8] docs: dt: writing-schema: Remove spurious indentation Rob Herring
2021-03-25 17:51   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 3/8] docs: dt: writing-schema: Include the example schema in the doc build Rob Herring
2021-03-25 17:52   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 4/8] docs: dt: Make 'Devicetree' wording more consistent Rob Herring
2021-03-25 17:25   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 5/8] docs: dt: Group DT docs into relevant sub-sections Rob Herring
2021-03-25 17:52   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 6/8] of: Fix kerneldoc output formatting Rob Herring
2021-03-25 17:46   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 7/8] of: Add missing 'Return' section in kerneldoc comments Rob Herring
2021-03-25 17:52   ` Mauro Carvalho Chehab
2021-03-25 16:47 ` [PATCH 8/8] docs: dt: Add DT API documentation Rob Herring
2021-03-25 17:53   ` Mauro Carvalho Chehab

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=20210325164713.1296407-1-robh@kernel.org \
    --to=robh@kernel.org \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=frowand.list@gmail.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@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;
as well as URLs for NNTP newsgroup(s).