linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Rob Herring <robh+dt@kernel.org>
To: Linus Walleij <linus.walleij@linaro.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	"open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS" 
	<devicetree@vger.kernel.org>,
	"H. Nikolaus Schaller" <hns@goldelico.com>,
	Jonathan Cameron <jic23@kernel.org>,
	Mark Rutland <mark.rutland@arm.com>,
	Andy Shevchenko <andriy.shevchenko@linux.intel.com>,
	Charles Keepax <ckeepax@opensource.cirrus.com>,
	Song Qiang <songqiang1304521@gmail.com>,
	Jean-Baptiste Maneyrol <jmaneyrol@invensense.com>,
	Martin Kelly <mkelly@xevo.com>,
	Jonathan Marek <jonathan@marek.ca>,
	Brian Masney <masneyb@onstation.org>,
	Stephan Gerhold <stephan@gerhold.net>,
	Discussions about the Letux Kernel 
	<letux-kernel@openphoenux.org>, Hartmut Knaack <knaack.h@gmx.de>,
	Lars-Peter Clausen <lars@metafoo.de>,
	Peter Meerwald-Stadler <pmeerw@pmeerw.net>,
	"open list:IIO SUBSYSTEM AND DRIVERS" <linux-iio@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Gregor Boirie <gregor.boirie@parrot.com>,
	Sebastian Reichel <sre@kernel.org>,
	Samu Onkalo <samu.onkalo@intel.com>
Subject: Re: [PATCH v2 02/10] iio: document bindings for mounting matrices
Date: Mon, 25 Feb 2019 13:38:12 -0600	[thread overview]
Message-ID: <CAL_JsqKZUoqonTcCFEaQeGpg1SxJ31cVu0=Bm5r_2TmjCYjG3Q@mail.gmail.com> (raw)
In-Reply-To: <CACRpkdZn6pS7vBwKk8FNnuSigZjHHjYciQ3V8WR_Fdb=COTdTw@mail.gmail.com>

On Mon, Feb 25, 2019 at 12:24 PM Linus Walleij <linus.walleij@linaro.org> wrote:
>
> Hi Jon,
>
> On Mon, Feb 25, 2019 at 5:32 PM Jonathan Corbet <corbet@lwn.net> wrote:
>
> > >  .../devicetree/bindings/iio/mount-matrix.txt  | 204 ++++++++++++++++++
>
> So this is a device tree binding.
>
> > So forgive me, but I have to ask: what are the chances of getting this
> > file in RST format?  It's 99% of the way there now, finishing the job
> > would allow it to be integrated into our docs tree.
> >
> > It should probably have an SPDX line too.
>
> The recent direction of the Device Tree bindings are not in the RST
> direction but in the direction of using another formal structure: YAML
> schemas.
>
> See e.g. Documentation/devicetree/bindings/example-schema.yaml
>
> The YAML schema makes it possible to verify device trees and examples
> inside the bindings to the specification using a context-free grammar.
>
> If we can join the RST and YAML ambitions is a good question. RST
> has nice typesetting properties, YAML has nice grammatic properties.

In fact there has been some experimentation there. The 'description'
portion of DT schema can be RST. And the rest being structured data
could be transformed to RST. Grant did some experiments there. The
idea being to generate the DT spec from schema (rather than integrate
into the kernel docs). But not much progress there and it's not
something I'm spending time on ATM.

Rob

  parent reply	other threads:[~2019-02-25 19:38 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-21 17:02 [PATCH v2 00/10] iio mount matrix - revitalize missing bindings documentation and provide code for bmc150, bmg160, bma180, itg3200, hmc584x H. Nikolaus Schaller
2019-02-21 17:02 ` [PATCH v2 01/10] iio: Allow to read mount matrix from ACPI H. Nikolaus Schaller
2019-03-03 14:59   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 02/10] iio: document bindings for mounting matrices H. Nikolaus Schaller
2019-02-22 23:42   ` Rob Herring
2019-02-25 16:32   ` Jonathan Corbet
2019-02-25 18:24     ` Linus Walleij
2019-02-25 18:29       ` Jonathan Corbet
2019-02-25 19:38       ` Rob Herring [this message]
2019-03-03 15:19   ` Jonathan Cameron
2019-03-07 12:53     ` H. Nikolaus Schaller
2019-07-23  7:42   ` Linus Walleij
2019-07-23  9:46     ` H. Nikolaus Schaller
2019-07-28  7:50       ` Jonathan Cameron
2019-07-28 10:07         ` Linus Walleij
2019-07-23 15:39     ` Andy Shevchenko
2019-02-21 17:02 ` [PATCH v2 03/10] iio: accel: bmc150: add mount matrix support H. Nikolaus Schaller
2019-03-03 15:20   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 04/10] iio: accel: bma180: " H. Nikolaus Schaller
2019-03-03 15:20   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 05/10] iio: gyro: bmg160: " H. Nikolaus Schaller
2019-03-03 15:21   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 06/10] iio: gyro: itg3200: " H. Nikolaus Schaller
2019-03-03 15:22   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 07/10] iio: magnetometer: bmc150: " H. Nikolaus Schaller
2019-03-03 15:23   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 08/10] iio: magnetometer: hmc5843: " H. Nikolaus Schaller
2019-03-03 15:24   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 09/10] iio: mpu6050: improve code readability H. Nikolaus Schaller
2019-03-03 15:30   ` Jonathan Cameron
2019-02-21 17:02 ` [PATCH v2 10/10] iio: ak8975: " H. Nikolaus Schaller
2019-03-03 15:30   ` Jonathan Cameron
2019-02-22 14:48 ` [PATCH v2 00/10] iio mount matrix - revitalize missing bindings documentation and provide code for bmc150, bmg160, bma180, itg3200, hmc584x Andy Shevchenko
2019-03-03 15:32   ` Jonathan Cameron
2019-04-04  6:29     ` H. Nikolaus Schaller
2019-04-07 11:41       ` Jonathan Cameron
2019-02-22 16:24 ` Linus Walleij

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='CAL_JsqKZUoqonTcCFEaQeGpg1SxJ31cVu0=Bm5r_2TmjCYjG3Q@mail.gmail.com' \
    --to=robh+dt@kernel.org \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=ckeepax@opensource.cirrus.com \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=gregor.boirie@parrot.com \
    --cc=hns@goldelico.com \
    --cc=jic23@kernel.org \
    --cc=jmaneyrol@invensense.com \
    --cc=jonathan@marek.ca \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=letux-kernel@openphoenux.org \
    --cc=linus.walleij@linaro.org \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mark.rutland@arm.com \
    --cc=masneyb@onstation.org \
    --cc=mkelly@xevo.com \
    --cc=pmeerw@pmeerw.net \
    --cc=samu.onkalo@intel.com \
    --cc=songqiang1304521@gmail.com \
    --cc=sre@kernel.org \
    --cc=stephan@gerhold.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).