linux-kernel - Re: [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst: avoid using ReST :doc:`foo` markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Wed, 16 Jun 2021 16:08:05 -0600
From:   Rob Herring <robh+dt@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Nícolas F. R. A. Prado 
        <nfraprado@...tonmail.com>,
        Geert Uytterhoeven <geert+renesas@...der.be>,
        devicetree@...r.kernel.org,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v2 11/29] docs: devicetree: bindings: submitting-patches.rst:
 avoid using ReST :doc:`foo` markup

On Wed, Jun 16, 2021 at 12:27 AM Mauro Carvalho Chehab
<mchehab+huawei@...nel.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@...nel.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
>