linux-kernel - Re: [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references

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]

Message-ID: <CAL_JsqKwo3J2rmqKJHaxg7d8sqgcG3L5sKUi0UpxayF-4yMXRQ@mail.gmail.com>
Date:   Fri, 9 Apr 2021 11:30:26 -0500
From:   Rob Herring <robh+dt@...nel.org>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Dmitry Torokhov <dmitry.torokhov@...il.com>,
        Guenter Roeck <linux@...ck-us.net>,
        Jonathan Cameron <Jonathan.Cameron@...wei.com>,
        Lee Jones <lee.jones@...aro.org>, devicetree@...r.kernel.org,
        Linux Input <linux-input@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references

On Fri, Apr 9, 2021 at 7:48 AM Mauro Carvalho Chehab
<mchehab+huawei@...nel.org> wrote:
>
> As documents have been renamed and moved around, their
> references will break, but this will be unnoticed, as the
> script which checks for it won't handle "../" references.
>
> So, replace them by the full patch.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  .../input/touchscreen/resistive-adc-touch.txt    |  2 +-
>  .../devicetree/bindings/mfd/motorola-cpcap.txt   | 16 ++++++++--------
>  2 files changed, 9 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt b/Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt
> index 51456c0e9a27..fee0da12474e 100644
> --- a/Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt
> +++ b/Documentation/devicetree/bindings/input/touchscreen/resistive-adc-touch.txt
> @@ -5,7 +5,7 @@ Required properties:
>   - compatible: must be "resistive-adc-touch"
>  The device must be connected to an ADC device that provides channels for
>  position measurement and optional pressure.
> -Refer to ../iio/iio-bindings.txt for details
> +Refer to Documentation/devicetree/bindings/iio/iio-bindings.txt for details

There's a downside to this in that the DT only repo[1] will have wrong
paths, but we no doubt already have lots of those. I guess a
consistent path is better and we can transform it if needed.

Rob

[1] https://git.kernel.org/pub/scm/linux/kernel/git/devicetree/devicetree-rebasing.git/