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

From: Rob Herring
Date: Fri Apr 09 2021 - 12:30:45 EST


On Fri, Apr 9, 2021 at 7:48 AM Mauro Carvalho Chehab
<mchehab+huawei@xxxxxxxxxx> 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@xxxxxxxxxx>
> ---
> .../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/