All of lore.kernel.org
 help / color / mirror / Atom feed
From: Rob Herring <robh+dt@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Dmitry Torokhov <dmitry.torokhov@gmail.com>,
	Guenter Roeck <linux@roeck-us.net>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Lee Jones <lee.jones@linaro.org>,
	devicetree@vger.kernel.org,
	Linux Input <linux-input@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references
Date: Fri, 9 Apr 2021 11:30:26 -0500	[thread overview]
Message-ID: <CAL_JsqKwo3J2rmqKJHaxg7d8sqgcG3L5sKUi0UpxayF-4yMXRQ@mail.gmail.com> (raw)
In-Reply-To: <68d3a1244119d1f2829c375b0ef554cf348bc89f.1617972339.git.mchehab+huawei@kernel.org>

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

  reply	other threads:[~2021-04-09 16:30 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-09 12:47 [PATCH v3 0/8] Fix broken documentation file references Mauro Carvalho Chehab
2021-04-09 12:47 ` [PATCH v3 1/8] dt-bindings: don't use ../dir for doc references Mauro Carvalho Chehab
2021-04-09 16:30   ` Rob Herring [this message]
2021-04-09 19:18   ` Rob Herring
2021-04-09 12:47 ` [PATCH v3 2/8] dt-bindings: fix references for iio-bindings.txt Mauro Carvalho Chehab
2021-04-09 16:28   ` Rob Herring
2021-04-09 19:18   ` Rob Herring
2021-04-09 12:47 ` [PATCH v3 3/8] dt-bindings:iio:adc: update motorola,cpcap-adc.yaml reference Mauro Carvalho Chehab
2021-04-09 19:23   ` Rob Herring
2021-04-09 12:47 ` [PATCH v3 4/8] docs: update sysfs-platform_profile.rst reference Mauro Carvalho Chehab
2021-04-09 12:47 ` [PATCH v3 5/8] docs: vcpu-requests.rst: fix reference for atomic ops Mauro Carvalho Chehab
2021-04-15 16:08   ` Paolo Bonzini
2021-04-09 12:47 ` [PATCH v3 6/8] docs: replace transation references for reporting-bugs.rst Mauro Carvalho Chehab
2021-04-09 22:04   ` Federico Vaga
2021-04-09 12:47 ` [PATCH v3 7/8] docs: translations/zh_CN: fix a typo at 8.Conclusion.rst Mauro Carvalho Chehab
2021-04-09 12:47 ` [PATCH v3 8/8] docs: sched-bwc.rst: fix a typo on a doc name Mauro Carvalho Chehab

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_JsqKwo3J2rmqKJHaxg7d8sqgcG3L5sKUi0UpxayF-4yMXRQ@mail.gmail.com \
    --to=robh+dt@kernel.org \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=corbet@lwn.net \
    --cc=devicetree@vger.kernel.org \
    --cc=dmitry.torokhov@gmail.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=mchehab+huawei@kernel.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.