All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Rob Herring <robh+dt@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Mark Rutland <mark.rutland@arm.com>,
	Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	Jason Cooper <jason@lakedaemon.net>,
	Marc Zyngier <marc.zyngier@arm.com>,
	Jacek Anaszewski <jacek.anaszewski@gmail.com>,
	Pavel Machek <pavel@ucw.cz>, Dan Murphy <dmurphy@ti.com>,
	"David S. Miller" <davem@davemloft.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Nicolas Ferre <nicolas.ferre@microchip.com>,
	"Paul E. McKenney" <paulmck@linux.ibm.com>, devicetree@
Subject: Re: [PATCH 08/10] dt: fix refs that were renamed to json with the same file name
Date: Mon, 20 May 2019 13:13:44 -0300	[thread overview]
Message-ID: <20190520131344.39635733@coco.lan> (raw)
In-Reply-To: <CAL_JsqKGzNBjxhvY2Vq9v8SXiND+7sjmsOwKkeu+gEM=2Y-n_A@mail.gmail.com>

Em Mon, 20 May 2019 10:57:47 -0500
Rob Herring <robh+dt@kernel.org> escreveu:

> On Mon, May 20, 2019 at 9:48 AM Mauro Carvalho Chehab
> <mchehab+samsung@kernel.org> wrote:
> >
> > This file was converted to json, but the references weren't  
> 
> Technically, converted to json-schema (the language) or yaml (the format).

Ok. Do you want me to change it at the patch and resend?

> 
> > renamed.
> >
> > Fixes: 66ed144f147a ("dt-bindings: interrupt-controller: Convert ARM GIC to json-schema")
> > (and other similar commits)
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >  Documentation/devicetree/bindings/arm/omap/crossbar.txt       | 2 +-
> >  .../devicetree/bindings/clock/samsung,s5pv210-clock.txt       | 2 +-
> >  .../bindings/interrupt-controller/marvell,odmi-controller.txt | 2 +-
> >  Documentation/devicetree/bindings/leds/irled/spi-ir-led.txt   | 2 +-
> >  MAINTAINERS                                                   | 4 ++--
> >  5 files changed, 6 insertions(+), 6 deletions(-)  
> 
> FYI, I'm actively looking for this in conversions now as we've had a
> few of these. For cases where we have a lot of references, I'm fixing
> this by keeping the .txt file with a reference to the .yaml file.

If the file name remains with the same name, except for the .txt -> .yaml,
you can just run the "scripts/documentation-file-ref-check --fix"
after this patch:

	Subject: [PATCH 04/10] scripts/documentation-file-ref-check: teach about .txt -> .yaml renames

and it should detect and automatically fix all the references. As any
auto-hint script, you need to double-check the results.

> I'll pick up the DT patches in the series.

OK. There are a few such fixes inside patch 10/10. Do you want me
to split it or can it go through Jonathan's doc tree?

Thanks,
Mauro

WARNING: multiple messages have this Message-ID (diff)
From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Rob Herring <robh+dt@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Mark Rutland <mark.rutland@arm.com>,
	Michael Turquette <mturquette@baylibre.com>,
	Stephen Boyd <sboyd@kernel.org>,
	Thomas Gleixner <tglx@linutronix.de>,
	Jason Cooper <jason@lakedaemon.net>,
	Marc Zyngier <marc.zyngier@arm.com>,
	Jacek Anaszewski <jacek.anaszewski@gmail.com>,
	Pavel Machek <pavel@ucw.cz>, Dan Murphy <dmurphy@ti.com>,
	"David S. Miller" <davem@davemloft.net>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Linus Walleij <linus.walleij@linaro.org>,
	Nicolas Ferre <nicolas.ferre@microchip.com>,
	"Paul E. McKenney" <paulmck@linux.ibm.com>,
	devicetree@vger.kernel.org, linux-clk <linux-clk@vger.kernel.org>,
	Linux LED Subsystem <linux-leds@vger.kernel.org>
Subject: Re: [PATCH 08/10] dt: fix refs that were renamed to json with the same file name
Date: Mon, 20 May 2019 13:13:44 -0300	[thread overview]
Message-ID: <20190520131344.39635733@coco.lan> (raw)
In-Reply-To: <CAL_JsqKGzNBjxhvY2Vq9v8SXiND+7sjmsOwKkeu+gEM=2Y-n_A@mail.gmail.com>

Em Mon, 20 May 2019 10:57:47 -0500
Rob Herring <robh+dt@kernel.org> escreveu:

> On Mon, May 20, 2019 at 9:48 AM Mauro Carvalho Chehab
> <mchehab+samsung@kernel.org> wrote:
> >
> > This file was converted to json, but the references weren't  
> 
> Technically, converted to json-schema (the language) or yaml (the format).

Ok. Do you want me to change it at the patch and resend?

> 
> > renamed.
> >
> > Fixes: 66ed144f147a ("dt-bindings: interrupt-controller: Convert ARM GIC to json-schema")
> > (and other similar commits)
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> >  Documentation/devicetree/bindings/arm/omap/crossbar.txt       | 2 +-
> >  .../devicetree/bindings/clock/samsung,s5pv210-clock.txt       | 2 +-
> >  .../bindings/interrupt-controller/marvell,odmi-controller.txt | 2 +-
> >  Documentation/devicetree/bindings/leds/irled/spi-ir-led.txt   | 2 +-
> >  MAINTAINERS                                                   | 4 ++--
> >  5 files changed, 6 insertions(+), 6 deletions(-)  
> 
> FYI, I'm actively looking for this in conversions now as we've had a
> few of these. For cases where we have a lot of references, I'm fixing
> this by keeping the .txt file with a reference to the .yaml file.

If the file name remains with the same name, except for the .txt -> .yaml,
you can just run the "scripts/documentation-file-ref-check --fix"
after this patch:

	Subject: [PATCH 04/10] scripts/documentation-file-ref-check: teach about .txt -> .yaml renames

and it should detect and automatically fix all the references. As any
auto-hint script, you need to double-check the results.

> I'll pick up the DT patches in the series.

OK. There are a few such fixes inside patch 10/10. Do you want me
to split it or can it go through Jonathan's doc tree?

Thanks,
Mauro

  reply	other threads:[~2019-05-20 16:13 UTC|newest]

Thread overview: 70+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-20 14:47 [PATCH 00/10] Fix broken documentation references at v5.2-rc1 Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 01/10] scripts/documentation-file-ref-check: better handle translations Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 02/10] scripts/documentation-file-ref-check: exclude false-positives Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 03/10] scripts/documentation-file-ref-check: improve tools ref handling Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 04/10] scripts/documentation-file-ref-check: teach about .txt -> .yaml renames Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 05/10] ABI: sysfs-devices-system-cpu: point to the right docs Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 06/10] isdn: mISDN: remove a bogus reference to a non-existing doc Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 07/10] mfd: madera: point to the right pinctrl binding file Mauro Carvalho Chehab
2019-05-20 15:42   ` Charles Keepax
2019-05-20 15:42     ` Charles Keepax
2019-05-20 18:48     ` Mauro Carvalho Chehab
2019-05-20 18:48       ` Mauro Carvalho Chehab
2019-05-20 14:47 ` [PATCH 08/10] dt: fix refs that were renamed to json with the same file name Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 15:57   ` Rob Herring
2019-05-20 15:57     ` Rob Herring
2019-05-20 16:13     ` Mauro Carvalho Chehab [this message]
2019-05-20 16:13       ` Mauro Carvalho Chehab
2019-05-20 23:00       ` Rob Herring
2019-05-20 23:00         ` Rob Herring
2019-05-20 14:47 ` [PATCH 09/10] dt: fix broken references to nand.txt Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 15:37   ` Miquel Raynal
2019-05-20 15:37     ` Miquel Raynal
2019-05-20 15:37     ` Miquel Raynal
2019-05-20 15:37     ` Miquel Raynal
2019-05-20 14:47 ` [PATCH 10/10] docs: fix broken documentation links Mauro Carvalho Chehab
2019-05-20 14:47 ` Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` [Xen-devel] " Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 14:47   ` mchehab+samsung
2019-05-20 14:47   ` Mauro Carvalho Chehab
2019-05-20 15:05   ` Wolfram Sang
2019-05-20 15:05     ` Wolfram Sang
2019-05-20 15:05     ` [Xen-devel] " Wolfram Sang
2019-05-20 15:05     ` Wolfram Sang
2019-05-20 15:05     ` Wolfram Sang
2019-05-20 15:05     ` Wolfram Sang
2019-05-20 15:05     ` wsa
2019-05-20 15:05   ` Wolfram Sang
2019-05-20 15:05   ` Wolfram Sang
2019-05-21 22:56   ` Federico Vaga
2019-05-21 22:56     ` Federico Vaga
2019-05-21 22:56     ` [Xen-devel] " Federico Vaga
2019-05-21 22:56     ` Federico Vaga
2019-05-21 22:56     ` Federico Vaga
2019-05-21 22:56     ` Federico Vaga
2019-05-21 22:56     ` federico.vaga
2019-05-21 22:56   ` Federico Vaga
2019-05-21 22:56   ` Federico Vaga
2019-05-27  8:43   ` Rafael J. Wysocki
2019-05-27  8:43     ` [Devel] " Rafael J. Wysocki
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43     ` [Xen-devel] " Rafael J. Wysocki
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43     ` rafael
2019-05-27  8:43     ` Rafael J. Wysocki
2019-05-27  8:43   ` Rafael J. Wysocki
2019-05-27  8:43   ` Rafael J. Wysocki
2019-05-21 22:54 ` [PATCH 00/10] Fix broken documentation references at v5.2-rc1 Federico Vaga
2019-05-22  0:26   ` Mauro Carvalho Chehab
2019-05-22 20:18     ` Federico Vaga

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=20190520131344.39635733@coco.lan \
    --to=mchehab+samsung@kernel.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=dmurphy@ti.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jacek.anaszewski@gmail.com \
    --cc=jason@lakedaemon.net \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=marc.zyngier@arm.com \
    --cc=mark.rutland@arm.com \
    --cc=mchehab@infradead.org \
    --cc=mturquette@baylibre.com \
    --cc=nicolas.ferre@microchip.com \
    --cc=paulmck@linux.ibm.com \
    --cc=pavel@ucw.cz \
    --cc=robh+dt@kernel.org \
    --cc=sboyd@kernel.org \
    --cc=tglx@linutronix.de \
    /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.