From: Rob Herring <robh+dt@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: "Jonathan Corbet" <corbet@lwn.net>,
"Linux Doc Mailing List" <linux-doc@vger.kernel.org>,
"Nícolas F. R. A. Prado" <nfraprado@protonmail.com>,
"Geert Uytterhoeven" <geert+renesas@glider.be>,
devicetree@vger.kernel.org,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: avoid using ReST :doc:`foo` markup
Date: Wed, 16 Jun 2021 16:08:05 -0600 [thread overview]
Message-ID: <CAL_JsqLtZhox5-d81FnWywqM6waBv5fJ26z2n9rMw8wrn4aDqg@mail.gmail.com> (raw)
In-Reply-To: <0048c23d47b582dd1a1959628fd2b895209ac826.1623824363.git.mchehab+huawei@kernel.org>
On Wed, Jun 16, 2021 at 12:27 AM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> The :doc:`foo` tag is auto-generated via automarkup.py.
> So, use the filename at the sources, instead of :doc:`foo`.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> .../devicetree/bindings/submitting-patches.rst | 11 ++++++-----
> 1 file changed, 6 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/submitting-patches.rst b/Documentation/devicetree/bindings/submitting-patches.rst
> index 104fa8fb2c17..8087780f1685 100644
> --- a/Documentation/devicetree/bindings/submitting-patches.rst
> +++ b/Documentation/devicetree/bindings/submitting-patches.rst
> @@ -7,8 +7,8 @@ Submitting Devicetree (DT) binding patches
> I. For patch submitters
> =======================
>
> - 0) Normal patch submission rules from Documentation/process/submitting-patches.rst
> - applies.
> + 0) Normal patch submission rules from
> + Documentation/process/submitting-patches.rst applies.
>
> 1) The Documentation/ and include/dt-bindings/ portion of the patch should
> be a separate patch. The preferred subject prefix for binding patches is::
> @@ -25,8 +25,8 @@ I. For patch submitters
>
> make dt_binding_check
>
> - See Documentation/devicetree/bindings/writing-schema.rst for more details about
> - schema and tools setup.
> + See Documentation/devicetree/bindings/writing-schema.rst for more details
> + about schema and tools setup.
These don't match $subject.
>
> 3) DT binding files should be dual licensed. The preferred license tag is
> (GPL-2.0-only OR BSD-2-Clause).
> @@ -84,7 +84,8 @@ II. For kernel maintainers
> III. Notes
> ==========
>
> - 0) Please see :doc:`ABI` for details regarding devicetree ABI.
> + 0) Please see Documentation/devicetree/bindings/ABI.rst for details
> + regarding devicetree ABI.
Is this new? You did review my oneliner adding ':doc:' not too long ago.
>
> 1) This document is intended as a general familiarization with the process as
> decided at the 2013 Kernel Summit. When in doubt, the current word of the
> --
> 2.31.1
>
next prev parent reply other threads:[~2021-06-16 22:08 UTC|newest]
Thread overview: 42+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-06-16 6:27 [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 01/29] docs: devices.rst: better reference documentation docs Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 02/29] docs: dev-tools: kunit: don't use a table for docs name Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 03/29] docs: admin-guide: pm: avoid using ReST :doc:`foo` markup Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 04/29] docs: admin-guide: hw-vuln: " Mauro Carvalho Chehab
2021-06-16 18:21 ` mark gross
2021-06-16 20:21 ` Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 05/29] docs: admin-guide: sysctl: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 06/29] docs: block: biodoc.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 07/29] docs: bpf: bpf_lsm.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 08/29] docs: core-api: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 09/29] docs: dev-tools: testing-overview.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 10/29] docs: dev-tools: kunit: " Mauro Carvalho Chehab
2021-06-25 21:27 ` Brendan Higgins
2021-06-25 22:12 ` Jonathan Corbet
2021-06-16 6:27 ` [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 22:08 ` Rob Herring [this message]
2021-06-17 6:38 ` Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 12/29] docs: doc-guide: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 13/29] docs: driver-api: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 14/29] docs: driver-api: gpio: using-gpio.rst: " Mauro Carvalho Chehab
2021-06-25 10:37 ` Bartosz Golaszewski
2021-06-16 6:27 ` [PATCH v2 15/29] docs: driver-api: surface_aggregator: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 16/29] docs: driver-api: usb: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 17/29] docs: firmware-guide: acpi: " Mauro Carvalho Chehab
2021-06-16 6:55 ` Sakari Ailus
2021-06-16 6:27 ` [PATCH v2 18/29] docs: i2c: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 19/29] docs: kernel-hacking: hacking.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 20/29] docs: networking: devlink: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 21/29] docs: PCI: endpoint: pci-endpoint-cfs.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 22/29] docs: PCI: pci.rst: " Mauro Carvalho Chehab
2021-06-16 14:17 ` Bjorn Helgaas
2021-06-16 6:27 ` [PATCH v2 23/29] docs: process: submitting-patches.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 24/29] docs: security: landlock.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 25/29] docs: trace: coresight: coresight.rst: " Mauro Carvalho Chehab
2021-06-17 15:03 ` Mathieu Poirier
2021-06-16 6:27 ` [PATCH v2 26/29] docs: trace: ftrace.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 27/29] docs: userspace-api: landlock.rst: " Mauro Carvalho Chehab
2021-06-23 12:26 ` Mickaël Salaün
2021-06-16 6:27 ` [PATCH v2 28/29] docs: virt: kvm: s390-pv-boot.rst: " Mauro Carvalho Chehab
2021-06-16 6:27 ` [PATCH v2 29/29] docs: x86: " Mauro Carvalho Chehab
2021-06-17 19:34 ` [PATCH v2 00/29] docs: avoid using ReST :doc:`foo` tag Jonathan Corbet
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_JsqLtZhox5-d81FnWywqM6waBv5fJ26z2n9rMw8wrn4aDqg@mail.gmail.com \
--to=robh+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=geert+renesas@glider.be \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=nfraprado@protonmail.com \
/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).