| Message ID | 967df5c3303b478b76199d4379fe40f5094f3f9b.1588584538.git.mchehab+huawei@kernel.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs: dt: fix broken links due to txt->yaml renames | expand |
On Mon, 2020-05-04 at 11:30 +0200, Mauro Carvalho Chehab wrote: > There are some new broken doc links due to yaml renames > at DT. Developers should really run: > > ./scripts/documentation-file-ref-check > > in order to solve those issues while submitting patches. > This tool can even fix most of the issues with: > > ./scripts/documentation-file-ref-check --fix Thanks Mauro.
Hi Mauro. On Mon, May 04, 2020 at 11:30:20AM +0200, Mauro Carvalho Chehab wrote: > There are some new broken doc links due to yaml renames > at DT. Developers should really run: > > ./scripts/documentation-file-ref-check > > in order to solve those issues while submitting patches. Would love if some bot could do this for me on any patches that creates .yaml files or so. I know I will forget this and it can be automated. If I get a bot mail that my patch would broke a link I would have it fixed before it hits any tree. > This tool can even fix most of the issues with: > > ./scripts/documentation-file-ref-check --fix > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Patch looks good. Acked-by: Sam Ravnborg <sam@ravnborg.org> > --- > > PS.: This patch is against today's linux-next. > > > .../devicetree/bindings/display/bridge/sii902x.txt | 2 +- > .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- > .../devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- > .../devicetree/bindings/sound/audio-graph-card.txt | 2 +- > .../devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- > Documentation/mips/ingenic-tcu.rst | 2 +- > MAINTAINERS | 6 +++--- > 7 files changed, 9 insertions(+), 9 deletions(-) > > diff --git a/Documentation/devicetree/bindings/display/bridge/sii902x.txt b/Documentation/devicetree/bindings/display/bridge/sii902x.txt > index 6e14e087c0d0..0d1db3f9da84 100644 > --- a/Documentation/devicetree/bindings/display/bridge/sii902x.txt > +++ b/Documentation/devicetree/bindings/display/bridge/sii902x.txt > @@ -37,7 +37,7 @@ Optional properties: > simple-card or audio-graph-card binding. See their binding > documents on how to describe the way the sii902x device is > connected to the rest of the audio system: > - Documentation/devicetree/bindings/sound/simple-card.txt > + Documentation/devicetree/bindings/sound/simple-card.yaml > Documentation/devicetree/bindings/sound/audio-graph-card.txt > Note: In case of the audio-graph-card binding the used port > index should be 3. > diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml > index ec8ae742d4da..7204da5eb4c5 100644 > --- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml > +++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml > @@ -24,7 +24,7 @@ properties: > description: | > Should contain a list of phandles pointing to display interface port > of vop devices. vop definitions as defined in > - Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt > + Documentation/devicetree/bindings/display/rockchip/rockchip-vop.yaml > > required: > - compatible > diff --git a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt > index 219bcbd0d344..9ef5bacda8c1 100644 > --- a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt > +++ b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt > @@ -3,7 +3,7 @@ MediaTek SoC built-in Bluetooth Devices > > This device is a serial attached device to BTIF device and thus it must be a > child node of the serial node with BTIF. The dt-bindings details for BTIF > -device can be known via Documentation/devicetree/bindings/serial/8250.txt. > +device can be known via Documentation/devicetree/bindings/serial/8250.yaml. > > Required properties: > > diff --git a/Documentation/devicetree/bindings/sound/audio-graph-card.txt b/Documentation/devicetree/bindings/sound/audio-graph-card.txt > index 269682619a70..d5f6919a2d69 100644 > --- a/Documentation/devicetree/bindings/sound/audio-graph-card.txt > +++ b/Documentation/devicetree/bindings/sound/audio-graph-card.txt > @@ -5,7 +5,7 @@ It is based on common bindings for device graphs. > see ${LINUX}/Documentation/devicetree/bindings/graph.txt > > Basically, Audio Graph Card property is same as Simple Card. > -see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.txt > +see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.yaml > > Below are same as Simple-Card. > > diff --git a/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt b/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt > index 4d51f3f5ea98..a6ffcdec6f6a 100644 > --- a/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt > +++ b/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt > @@ -5,7 +5,7 @@ codec or external codecs. > > sti sound drivers allows to expose sti SoC audio interface through the > generic ASoC simple card. For details about sound card declaration please refer to > -Documentation/devicetree/bindings/sound/simple-card.txt. > +Documentation/devicetree/bindings/sound/simple-card.yaml. > > 1) sti-uniperiph-dai: audio dai device. > --------------------------------------- > diff --git a/Documentation/mips/ingenic-tcu.rst b/Documentation/mips/ingenic-tcu.rst > index c5a646b14450..2b75760619b4 100644 > --- a/Documentation/mips/ingenic-tcu.rst > +++ b/Documentation/mips/ingenic-tcu.rst > @@ -68,4 +68,4 @@ and frameworks can be controlled from the same registers, all of these > drivers access their registers through the same regmap. > > For more information regarding the devicetree bindings of the TCU drivers, > -have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.txt. > +have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.yaml. > diff --git a/MAINTAINERS b/MAINTAINERS > index b6ec0b3c3125..b70842425302 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -3911,7 +3911,7 @@ L: linux-crypto@vger.kernel.org > S: Supported > F: drivers/char/hw_random/cctrng.c > F: drivers/char/hw_random/cctrng.h > -F: Documentation/devicetree/bindings/rng/arm-cctrng.txt > +F: Documentation/devicetree/bindings/rng/arm-cctrng.yaml > W: https://developer.arm.com/products/system-ip/trustzone-cryptocell/cryptocell-700-family > > CEC FRAMEWORK > @@ -5446,7 +5446,7 @@ F: include/uapi/drm/r128_drm.h > DRM DRIVER FOR RAYDIUM RM67191 PANELS > M: Robert Chiras <robert.chiras@nxp.com> > S: Maintained > -F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.txt > +F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.yaml > F: drivers/gpu/drm/panel/panel-raydium-rm67191.c > > DRM DRIVER FOR ROCKTECH JH057N00900 PANELS > @@ -16294,7 +16294,7 @@ M: Hoan Tran <hoan@os.amperecomputing.com> > M: Serge Semin <fancer.lancer@gmail.com> > L: linux-gpio@vger.kernel.org > S: Maintained > -F: Documentation/devicetree/bindings/gpio/snps-dwapb-gpio.txt > +F: Documentation/devicetree/bindings/gpio/snps,dw-apb-gpio.yaml > F: drivers/gpio/gpio-dwapb.c > > SYNOPSYS DESIGNWARE AXI DMAC DRIVER > -- > 2.25.4 > > _______________________________________________ > dri-devel mailing list > dri-devel@lists.freedesktop.org > https://lists.freedesktop.org/mailman/listinfo/dri-devel
Hi Sam, On Mon, May 04, 2020 at 07:45:22PM +0200, Sam Ravnborg wrote: > On Mon, May 04, 2020 at 11:30:20AM +0200, Mauro Carvalho Chehab wrote: > > There are some new broken doc links due to yaml renames > > at DT. Developers should really run: > > > > ./scripts/documentation-file-ref-check > > > > in order to solve those issues while submitting patches. > Would love if some bot could do this for me on any patches that creates > .yaml files or so. > I know I will forget this and it can be automated. > If I get a bot mail that my patch would broke a link I would > have it fixed before it hits any tree. What about adding a check to check_patch? Best regards Uwe
On Mon, 2020-05-04 at 19:55 +0200, Uwe Kleine-König wrote: > Hi Sam, > > On Mon, May 04, 2020 at 07:45:22PM +0200, Sam Ravnborg wrote: > > On Mon, May 04, 2020 at 11:30:20AM +0200, Mauro Carvalho Chehab wrote: > > > There are some new broken doc links due to yaml renames > > > at DT. Developers should really run: > > > > > > ./scripts/documentation-file-ref-check > > > > > > in order to solve those issues while submitting patches. > > Would love if some bot could do this for me on any patches that creates > > .yaml files or so. > > I know I will forget this and it can be automated. > > If I get a bot mail that my patch would broke a link I would > > have it fixed before it hits any tree. > > What about adding a check to check_patch? There's already a checkpatch warning when a patch renames a file without a MAINTAINERS update.
On Mon, May 4, 2020 at 12:56 PM Uwe Kleine-König <u.kleine-koenig@pengutronix.de> wrote: > > Hi Sam, > > On Mon, May 04, 2020 at 07:45:22PM +0200, Sam Ravnborg wrote: > > On Mon, May 04, 2020 at 11:30:20AM +0200, Mauro Carvalho Chehab wrote: > > > There are some new broken doc links due to yaml renames > > > at DT. Developers should really run: > > > > > > ./scripts/documentation-file-ref-check > > > > > > in order to solve those issues while submitting patches. > > Would love if some bot could do this for me on any patches that creates > > .yaml files or so. > > I know I will forget this and it can be automated. > > If I get a bot mail that my patch would broke a link I would > > have it fixed before it hits any tree. I can probably add this to what I'm already checking. Not completely automated though as it depends on me to review before sending. > What about adding a check to check_patch? That would be the best way to get submitters to do this. Rob
On Mon, May 04, 2020 at 11:30:20AM +0200, Mauro Carvalho Chehab wrote: > There are some new broken doc links due to yaml renames > at DT. Developers should really run: > > ./scripts/documentation-file-ref-check > > in order to solve those issues while submitting patches. > This tool can even fix most of the issues with: > > ./scripts/documentation-file-ref-check --fix > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> > --- > > PS.: This patch is against today's linux-next. That's not a base anyone can apply this patch against. > > > .../devicetree/bindings/display/bridge/sii902x.txt | 2 +- > .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- > .../devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- > .../devicetree/bindings/sound/audio-graph-card.txt | 2 +- > .../devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- > Documentation/mips/ingenic-tcu.rst | 2 +- > MAINTAINERS | 6 +++--- > 7 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/Documentation/devicetree/bindings/display/bridge/sii902x.txt b/Documentation/devicetree/bindings/display/bridge/sii902x.txt index 6e14e087c0d0..0d1db3f9da84 100644 --- a/Documentation/devicetree/bindings/display/bridge/sii902x.txt +++ b/Documentation/devicetree/bindings/display/bridge/sii902x.txt @@ -37,7 +37,7 @@ Optional properties: simple-card or audio-graph-card binding. See their binding documents on how to describe the way the sii902x device is connected to the rest of the audio system: - Documentation/devicetree/bindings/sound/simple-card.txt + Documentation/devicetree/bindings/sound/simple-card.yaml Documentation/devicetree/bindings/sound/audio-graph-card.txt Note: In case of the audio-graph-card binding the used port index should be 3. diff --git a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml index ec8ae742d4da..7204da5eb4c5 100644 --- a/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml +++ b/Documentation/devicetree/bindings/display/rockchip/rockchip-drm.yaml @@ -24,7 +24,7 @@ properties: description: | Should contain a list of phandles pointing to display interface port of vop devices. vop definitions as defined in - Documentation/devicetree/bindings/display/rockchip/rockchip-vop.txt + Documentation/devicetree/bindings/display/rockchip/rockchip-vop.yaml required: - compatible diff --git a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt index 219bcbd0d344..9ef5bacda8c1 100644 --- a/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt +++ b/Documentation/devicetree/bindings/net/mediatek-bluetooth.txt @@ -3,7 +3,7 @@ MediaTek SoC built-in Bluetooth Devices This device is a serial attached device to BTIF device and thus it must be a child node of the serial node with BTIF. The dt-bindings details for BTIF -device can be known via Documentation/devicetree/bindings/serial/8250.txt. +device can be known via Documentation/devicetree/bindings/serial/8250.yaml. Required properties: diff --git a/Documentation/devicetree/bindings/sound/audio-graph-card.txt b/Documentation/devicetree/bindings/sound/audio-graph-card.txt index 269682619a70..d5f6919a2d69 100644 --- a/Documentation/devicetree/bindings/sound/audio-graph-card.txt +++ b/Documentation/devicetree/bindings/sound/audio-graph-card.txt @@ -5,7 +5,7 @@ It is based on common bindings for device graphs. see ${LINUX}/Documentation/devicetree/bindings/graph.txt Basically, Audio Graph Card property is same as Simple Card. -see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.txt +see ${LINUX}/Documentation/devicetree/bindings/sound/simple-card.yaml Below are same as Simple-Card. diff --git a/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt b/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt index 4d51f3f5ea98..a6ffcdec6f6a 100644 --- a/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt +++ b/Documentation/devicetree/bindings/sound/st,sti-asoc-card.txt @@ -5,7 +5,7 @@ codec or external codecs. sti sound drivers allows to expose sti SoC audio interface through the generic ASoC simple card. For details about sound card declaration please refer to -Documentation/devicetree/bindings/sound/simple-card.txt. +Documentation/devicetree/bindings/sound/simple-card.yaml. 1) sti-uniperiph-dai: audio dai device. --------------------------------------- diff --git a/Documentation/mips/ingenic-tcu.rst b/Documentation/mips/ingenic-tcu.rst index c5a646b14450..2b75760619b4 100644 --- a/Documentation/mips/ingenic-tcu.rst +++ b/Documentation/mips/ingenic-tcu.rst @@ -68,4 +68,4 @@ and frameworks can be controlled from the same registers, all of these drivers access their registers through the same regmap. For more information regarding the devicetree bindings of the TCU drivers, -have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.txt. +have a look at Documentation/devicetree/bindings/timer/ingenic,tcu.yaml. diff --git a/MAINTAINERS b/MAINTAINERS index b6ec0b3c3125..b70842425302 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3911,7 +3911,7 @@ L: linux-crypto@vger.kernel.org S: Supported F: drivers/char/hw_random/cctrng.c F: drivers/char/hw_random/cctrng.h -F: Documentation/devicetree/bindings/rng/arm-cctrng.txt +F: Documentation/devicetree/bindings/rng/arm-cctrng.yaml W: https://developer.arm.com/products/system-ip/trustzone-cryptocell/cryptocell-700-family CEC FRAMEWORK @@ -5446,7 +5446,7 @@ F: include/uapi/drm/r128_drm.h DRM DRIVER FOR RAYDIUM RM67191 PANELS M: Robert Chiras <robert.chiras@nxp.com> S: Maintained -F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.txt +F: Documentation/devicetree/bindings/display/panel/raydium,rm67191.yaml F: drivers/gpu/drm/panel/panel-raydium-rm67191.c DRM DRIVER FOR ROCKTECH JH057N00900 PANELS @@ -16294,7 +16294,7 @@ M: Hoan Tran <hoan@os.amperecomputing.com> M: Serge Semin <fancer.lancer@gmail.com> L: linux-gpio@vger.kernel.org S: Maintained -F: Documentation/devicetree/bindings/gpio/snps-dwapb-gpio.txt +F: Documentation/devicetree/bindings/gpio/snps,dw-apb-gpio.yaml F: drivers/gpio/gpio-dwapb.c SYNOPSYS DESIGNWARE AXI DMAC DRIVER
There are some new broken doc links due to yaml renames at DT. Developers should really run: ./scripts/documentation-file-ref-check in order to solve those issues while submitting patches. This tool can even fix most of the issues with: ./scripts/documentation-file-ref-check --fix Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> --- PS.: This patch is against today's linux-next. .../devicetree/bindings/display/bridge/sii902x.txt | 2 +- .../devicetree/bindings/display/rockchip/rockchip-drm.yaml | 2 +- .../devicetree/bindings/net/mediatek-bluetooth.txt | 2 +- .../devicetree/bindings/sound/audio-graph-card.txt | 2 +- .../devicetree/bindings/sound/st,sti-asoc-card.txt | 2 +- Documentation/mips/ingenic-tcu.rst | 2 +- MAINTAINERS | 6 +++--- 7 files changed, 9 insertions(+), 9 deletions(-)