2021-04-09 12:48:57

by Mauro Carvalho Chehab

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

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 <[email protected]>
---
.../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
- iio-channels: must have at least two channels connected to an ADC device.
These should correspond to the channels exposed by the ADC device and should
have the right index as the ADC device registers them. These channels
diff --git a/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt b/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
index 5ddcc8f4febc..ebdccfb600b9 100644
--- a/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
+++ b/Documentation/devicetree/bindings/mfd/motorola-cpcap.txt
@@ -16,14 +16,14 @@ Optional subnodes:
The sub-functions of CPCAP get their own node with their own compatible values,
which are described in the following files:

-- ../power/supply/cpcap-battery.txt
-- ../power/supply/cpcap-charger.txt
-- ../regulator/cpcap-regulator.txt
-- ../phy/phy-cpcap-usb.txt
-- ../input/cpcap-pwrbutton.txt
-- ../rtc/cpcap-rtc.txt
-- ../leds/leds-cpcap.txt
-- ../iio/adc/cpcap-adc.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-battery.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
+- Documentation/devicetree/bindings/regulator/cpcap-regulator.txt
+- Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt
+- Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
+- Documentation/devicetree/bindings/rtc/cpcap-rtc.txt
+- Documentation/devicetree/bindings/leds/leds-cpcap.txt
+- Documentation/devicetree/bindings/iio/adc/cpcap-adc.txt

The only exception is the audio codec. Instead of a compatible value its
node must be named "audio-codec".
--
2.30.2


2021-04-09 16:32:24

by Rob Herring

[permalink] [raw]
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
<[email protected]> 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 <[email protected]>
> ---
> .../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/

2021-04-09 19:19:45

by Rob Herring (Arm)

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

On Fri, 09 Apr 2021 14:47:45 +0200, Mauro Carvalho Chehab 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 <[email protected]>
> ---
> .../input/touchscreen/resistive-adc-touch.txt | 2 +-
> .../devicetree/bindings/mfd/motorola-cpcap.txt | 16 ++++++++--------
> 2 files changed, 9 insertions(+), 9 deletions(-)
>

Applied, thanks!