Skip to contentSkip to conversation

Fix broken docs references at next-20210602

PATCH Applied Mauro Carvalho Chehab 12 participants 36 messages Jun 2, 2021 – Jul 4, 2021

Subsystems (17)
lore
Share & tools
lore
#13 lore raw

PATCH 6/12 dt-bindings: iio: io-channel-mux.yaml: fix a typo

In reply to Mauro Carvalho Chehab

The file name: Documentation/device-tree/bindings/mux/mux-controller.yaml should be, instead: Documentation/devicetree/bindings/mux/mux-controller.yaml.

Update its cross-reference accordingly.

Fixes a66cec598f49 ("dt-bindings: iio: multiplexer: Convert io-channel-mux bindings to DT schema")
---
 .../devicetree/bindings/iio/multiplexer/io-channel-mux.yaml     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/iio/multiplexer/io-channel-mux.yaml +1 -1
index 37382b85f2b8..f37586702489 100644
@@ -17,7 +17,7 @@ description: |
   created. The number of this io-channel is the same as the index into the list
   of strings in the channels property, and also matches the mux controller
   state. The mux controller state is described in
-  Documentation/device-tree/bindings/mux/mux-controller.yaml
+  Documentation/devicetree/bindings/mux/mux-controller.yaml
 
 properties:
 
Signature · 1 line
2.31.1
#33 lore raw

PATCH 12/12 MAINTAINERS: update nxp,imx8-jpeg.yaml reference

In reply to Mauro Carvalho Chehab

The file name: Documentation/devicetree/bindings/media/imx8-jpeg.yaml should be, instead: Documentation/devicetree/bindings/media/nxp,imx8-jpeg.yaml.

Update its cross-reference accordingly.

Fixes be157db0a3d8 ("media: Add maintainer for IMX jpeg v4l2 driver")
Fixes b16ed1e66008 ("media: dt-bindings: Add bindings for i.MX8QXP/QM JPEG driver")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index a737ba26bdcd..37baabb1e7a5 100644
@@ -13303,7 +13303,7 @@ M:	Mirela Rabulea <[email protected]>
 R:	NXP Linux Team <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/devicetree/bindings/media/imx8-jpeg.yaml
+F:	Documentation/devicetree/bindings/media/nxp,imx8-jpeg.yaml
 F:	drivers/media/platform/imx-jpeg
 
 NZXT-KRAKEN2 HARDWARE MONITORING DRIVER
Signature · 1 line
2.31.1
#25 lore raw

PATCH 8/12 MAINTAINERS: update faraday,ftrtc010.yaml reference

In reply to Mauro Carvalho Chehab

Changeset 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
renamed: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
to: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml.

Update its cross-reference accordingly.

Fixes 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index 2800307082a9..8b423b7246a3 100644
@@ -1818,7 +1818,7 @@ T:	git git://github.com/ulli-kroll/linux.git
 F:	Documentation/devicetree/bindings/arm/gemini.txt
 F:	Documentation/devicetree/bindings/net/cortina,gemini-ethernet.txt
 F:	Documentation/devicetree/bindings/pinctrl/cortina,gemini-pinctrl.txt
-F:	Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
+F:	Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml
 F:	arch/arm/mach-gemini/
 F:	drivers/net/ethernet/cortina/
 F:	drivers/pinctrl/pinctrl-gemini.c
Signature · 1 line
2.31.1
#3 lore raw

PATCH 2/12 dt-bindings: power: supply: cpcap-charger: update cpcap-charger.yaml reference

In reply to Mauro Carvalho Chehab

Changeset ce49e4282200 ("dt-bindings: power: supply: cpcap-charger: Convert to DT schema format")
renamed: Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
to: Documentation/devicetree/bindings/power/supply/cpcap-charger.yaml.

Update its cross-reference accordingly.

Fixes ce49e4282200 ("dt-bindings: power: supply: cpcap-charger: Convert to DT schema format")
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/motorola-cpcap.txt +1 -1
index e656e6f08fed..190230216de8 100644
@@ -17,7 +17,7 @@ The sub-functions of CPCAP get their own node with their own compatible values,
 which are described in the following files:
 
 - Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml
-- Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-charger.yaml
 - Documentation/devicetree/bindings/regulator/cpcap-regulator.txt
 - Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt
 - Documentation/devicetree/bindings/input/cpcap-pwrbutton.txt
Signature · 1 line
2.31.1
#32 lore raw

PATCH 11/12 MAINTAINERS: update ti,sci.yaml reference

In reply to Mauro Carvalho Chehab

Changeset 5a9652f6994e ("dt-bindings: arm: keystone: Convert ti,sci to json schema")
renamed: Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
to: Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml.

Update its cross-reference accordingly.

Fixes 5a9652f6994e ("dt-bindings: arm: keystone: Convert ti,sci to json schema")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index 7d65784df8c8..a737ba26bdcd 100644
@@ -18192,7 +18192,7 @@ M:	Santosh Shilimkar <[email protected]>
 L:	[email protected]
 S:	Maintained
 F:	Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
-F:	Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
+F:	Documentation/devicetree/bindings/arm/keystone/ti,sci.yaml
 F:	Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml
Signature · 1 line
2.31.1
#1 lore raw

PATCH 1/12 dt-bindings: power: supply: cpcap-battery: update cpcap-battery.yaml reference

In reply to Mauro Carvalho Chehab

Changeset 3c5be0454972 ("dt-bindings: power: supply: cpcap-battery: Convert to DT schema format")
renamed: Documentation/devicetree/bindings/power/supply/cpcap-battery.txt
to: Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml.

Update its cross-reference accordingly.

Fixes 3c5be0454972 ("dt-bindings: power: supply: cpcap-battery: Convert to DT schema format")
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/devicetree/bindings/mfd/motorola-cpcap.txt +1 -1
index b52e7a33f0f9..e656e6f08fed 100644
@@ -16,7 +16,7 @@ Optional subnodes:
 The sub-functions of CPCAP get their own node with their own compatible values,
 which are described in the following files:
 
-- Documentation/devicetree/bindings/power/supply/cpcap-battery.txt
+- Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml
 - Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
 - Documentation/devicetree/bindings/regulator/cpcap-regulator.txt
 - Documentation/devicetree/bindings/phy/phy-cpcap-usb.txt
Signature · 1 line
2.31.1
#28 lore raw

PATCH 9/12 MAINTAINERS: update marvell,armada-3700-utmi-phy.yaml reference

In reply to Mauro Carvalho Chehab

Changeset 6569d8386388 ("dt-bindings: phy: convert phy-mvebu-utmi to YAML schema")
renamed: Documentation/devicetree/bindings/phy/phy-mvebu-utmi.txt
to: Documentation/devicetree/bindings/phy/marvell,armada-3700-utmi-phy.yaml.

Update its cross-reference accordingly.

Fixes 6569d8386388 ("dt-bindings: phy: convert phy-mvebu-utmi to YAML schema")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index 8b423b7246a3..644572ab4b2d 100644
@@ -10960,7 +10960,7 @@ MARVELL ARMADA 3700 PHY DRIVERS
 M:	Miquel Raynal <[email protected]>
 S:	Maintained
 F:	Documentation/devicetree/bindings/phy/phy-mvebu-comphy.txt
-F:	Documentation/devicetree/bindings/phy/phy-mvebu-utmi.txt
+F:	Documentation/devicetree/bindings/phy/marvell,armada-3700-utmi-phy.yaml
 F:	drivers/phy/marvell/phy-mvebu-a3700-comphy.c
 F:	drivers/phy/marvell/phy-mvebu-a3700-utmi.c
 
Signature · 1 line
2.31.1
#8 lore raw

PATCH 4/12 dt-bindings: clock: update ti,sci-clk.yaml references

In reply to Mauro Carvalho Chehab

Changeset a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
renamed: Documentation/devicetree/bindings/clock/ti,sci-clk.txt
to: Documentation/devicetree/bindings/clock/ti,sci-clk.yaml.

Update the cross-references accordingly.

Fixes a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
---
 Documentation/devicetree/bindings/gpio/gpio-davinci.txt | 2 +-
 Documentation/devicetree/bindings/i2c/i2c-davinci.txt   | 2 +-
 Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt | 2 +-
 Documentation/devicetree/bindings/net/can/c_can.txt     | 2 +-
 Documentation/devicetree/bindings/spi/spi-davinci.txt   | 2 +-
 MAINTAINERS                                             | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)
Documentation/devicetree/bindings/gpio/gpio-davinci.txt +1 -1
index 696ea46227d1..8ad4fd9aaffd 100644
@@ -32,7 +32,7 @@ Required Properties:
           Documentation/devicetree/bindings/clock/keystone-gate.txt
                             for 66AK2HK/66AK2L/66AK2E SoCs or,
 
-          Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+          Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
                             for 66AK2G SoCs
 
 - clock-names: Name should be "gpio";
Documentation/devicetree/bindings/i2c/i2c-davinci.txt +1 -1
index b35ad748ed68..6590501c53d4 100644
@@ -8,7 +8,7 @@ Required properties:
 - reg : Offset and length of the register set for the device
 - clocks: I2C functional clock phandle.
 	  For 66AK2G this property should be set per binding,
-	  Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+	  Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 
 SoC-specific Required Properties:
 
Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt +1 -1
index 0663e7648ef9..57d077c0b7c1 100644
@@ -28,7 +28,7 @@ The following are mandatory properties for 66AK2G SoCs only:
 		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 - clocks:	Must contain an entry for each entry in clock-names. Should
 		be defined as per the he appropriate clock bindings consumer
-		usage in Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+		usage in Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 - clock-names:	Shall be "fck" for the functional clock,
 		and "mmchsdb_fck" for the debounce clock.
 
Documentation/devicetree/bindings/net/can/c_can.txt +1 -1
index febd2cc1ca14..366479806acb 100644
@@ -22,7 +22,7 @@ The following are mandatory properties for Keystone 2 66AK2G SoCs only:
 			  Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 - clocks		: CAN functional clock phandle. This property is as per the
 			  binding,
-			  Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+			  Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 
 Optional properties:
 - syscon-raminit	: Handle to system control region that contains the
Documentation/devicetree/bindings/spi/spi-davinci.txt +1 -1
index e2198a389484..200c7fc7b089 100644
@@ -25,7 +25,7 @@ Required properties:
 - interrupts: interrupt number mapped to CPU.
 - clocks: spi clk phandle
           For 66AK2G this property should be set per binding,
-          Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+          Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 
 SoC-specific Required Properties:
 
MAINTAINERS +1 -1
index 0f0a01b54c1b..790eff88b53e 100644
@@ -18193,7 +18193,7 @@ L:	[email protected]
 S:	Maintained
 F:	Documentation/devicetree/bindings/arm/keystone/ti,k3-sci-common.yaml
 F:	Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
-F:	Documentation/devicetree/bindings/clock/ti,sci-clk.txt
+F:	Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml
 F:	Documentation/devicetree/bindings/reset/ti,sci-reset.txt
Signature · 1 line
2.31.1
#30 lore raw

PATCH 10/12 MAINTAINERS: update ti,omap-gpio.yaml reference

In reply to Mauro Carvalho Chehab

Changeset bc3aca5393c4 ("dt-bindings: gpio: omap: Convert to json-schema")
renamed: Documentation/devicetree/bindings/gpio/gpio-omap.txt
to: Documentation/devicetree/bindings/gpio/ti,omap-gpio.yaml.

Update its cross-reference accordingly.

Fixes bc3aca5393c4 ("dt-bindings: gpio: omap: Convert to json-schema")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index 644572ab4b2d..7d65784df8c8 100644
@@ -13412,7 +13412,7 @@ M:	Santosh Shilimkar <[email protected]>
 M:	Kevin Hilman <[email protected]>
 L:	[email protected]
 S:	Maintained
-F:	Documentation/devicetree/bindings/gpio/gpio-omap.txt
+F:	Documentation/devicetree/bindings/gpio/ti,omap-gpio.yaml
 F:	drivers/gpio/gpio-omap.c
 
 OMAP HARDWARE SPINLOCK SUPPORT
Signature · 1 line
2.31.1
#0 lore raw

cover Fix broken docs references at next-20210602

There are some broken references at today's linux-next with regards to files inside Documentation/.

Address them.

Mauro Carvalho Chehab (12):
dt-bindings: power: supply: cpcap-battery: update cpcap-battery.yaml
reference
dt-bindings: power: supply: cpcap-charger: update cpcap-charger.yaml
reference
dt-bindings: soc: ti: update sci-pm-domain.yaml references
dt-bindings: clock: update ti,sci-clk.yaml references
dt-bindings: reset: update ti,sci-reset.yaml references
dt-bindings: iio: io-channel-mux.yaml: fix a typo
docs: accounting: update delay-accounting.rst reference
MAINTAINERS: update faraday,ftrtc010.yaml reference
MAINTAINERS: update marvell,armada-3700-utmi-phy.yaml reference
MAINTAINERS: update ti,omap-gpio.yaml reference
MAINTAINERS: update ti,sci.yaml reference
MAINTAINERS: update nxp,imx8-jpeg.yaml reference

 Documentation/admin-guide/sysctl/kernel.rst      |  2 +-
 .../devicetree/bindings/dma/ti-edma.txt          |  4 ++--
 .../devicetree/bindings/gpio/gpio-davinci.txt    |  2 +-
 .../devicetree/bindings/i2c/i2c-davinci.txt      |  4 ++--
 .../bindings/iio/multiplexer/io-channel-mux.yaml |  2 +-
 .../devicetree/bindings/mfd/motorola-cpcap.txt   |  4 ++--
 .../devicetree/bindings/mmc/ti-omap-hsmmc.txt    |  4 ++--
 .../devicetree/bindings/net/can/c_can.txt        |  4 ++--
 .../bindings/remoteproc/ti,keystone-rproc.txt    |  4 ++--
 .../devicetree/bindings/spi/spi-davinci.txt      |  2 +-
 .../devicetree/bindings/usb/ti,j721e-usb.yaml    |  2 +-
 .../bindings/usb/ti,keystone-dwc3.yaml           |  2 +-
 MAINTAINERS                                      | 16 ++++++++--------
 13 files changed, 26 insertions(+), 26 deletions(-)
Signature · 1 line
2.31.1
#15 lore raw

PATCH 7/12 docs: accounting: update delay-accounting.rst reference

When :doc: is used, the .rst should be removed. Also, the patches are relative to the current directory.

So, the right reference should be:

:doc:/accounting/delay-accounting

Fixes fcb501704554 ("delayacct: Document task_delayacct sysctl")
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +1 -1
index b2057173fe07..7f36cba3204b 100644
@@ -1097,7 +1097,7 @@ task_delayacct
 ===============
 
 Enables/disables task delay accounting (see
-:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
+:doc:`/accounting/delay-accounting`). Enabling this feature incurs
 a small amount of overhead in the scheduler but is useful for debugging
 and performance tuning. It is required by some tools such as iotop.
 
Signature · 1 line
2.31.1
#5 lore raw

PATCH 3/12 dt-bindings: soc: ti: update sci-pm-domain.yaml references

In reply to Mauro Carvalho Chehab

Changeset fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
renamed: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
to: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml.

Update the cross-references accordingly.

Fixes fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
---
 Documentation/devicetree/bindings/dma/ti-edma.txt             | 4 ++--
 Documentation/devicetree/bindings/i2c/i2c-davinci.txt         | 2 +-
 Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt       | 2 +-
 Documentation/devicetree/bindings/net/can/c_can.txt           | 2 +-
 .../devicetree/bindings/remoteproc/ti,keystone-rproc.txt      | 2 +-
 Documentation/devicetree/bindings/usb/ti,j721e-usb.yaml       | 2 +-
 Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml   | 2 +-
 MAINTAINERS                                                   | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)
Documentation/devicetree/bindings/dma/ti-edma.txt +2 -2
index 29fcd37082e8..f719e1612b0a 100644
@@ -33,7 +33,7 @@ The following are mandatory properties for 66AK2G SoCs only:
 - power-domains:Should contain a phandle to a PM domain provider node
 		and an args specifier containing the device id
 		value. This property is as per the binding,
-		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 
 Optional properties:
 -------------------
@@ -70,7 +70,7 @@ The following are mandatory properties for 66AK2G SoCs only:
 - power-domains:Should contain a phandle to a PM domain provider node
 		and an args specifier containing the device id
 		value. This property is as per the binding,
-		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 
 Optional properties:
 -------------------
Documentation/devicetree/bindings/i2c/i2c-davinci.txt +1 -1
index b745f3706120..b35ad748ed68 100644
@@ -17,7 +17,7 @@ The following are mandatory properties for Keystone 2 66AK2G SoCs only:
 - power-domains:	Should contain a phandle to a PM domain provider node
 			and an args specifier containing the I2C device id
 			value. This property is as per the binding,
-			Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+			Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 
 Recommended properties :
 - interrupts : standard interrupt property.
Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt +1 -1
index 4a9145ef15d6..0663e7648ef9 100644
@@ -25,7 +25,7 @@ The following are mandatory properties for 66AK2G SoCs only:
 - power-domains:Should contain a phandle to a PM domain provider node
 		and an args specifier containing the MMC device id
 		value. This property is as per the binding,
-		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+		Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 - clocks:	Must contain an entry for each entry in clock-names. Should
 		be defined as per the he appropriate clock bindings consumer
 		usage in Documentation/devicetree/bindings/clock/ti,sci-clk.txt
Documentation/devicetree/bindings/net/can/c_can.txt +1 -1
index 2d504256b0d8..febd2cc1ca14 100644
@@ -19,7 +19,7 @@ The following are mandatory properties for Keystone 2 66AK2G SoCs only:
 - power-domains		: Should contain a phandle to a PM domain provider node
 			  and an args specifier containing the DCAN device id
 			  value. This property is as per the binding,
-			  Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+			  Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 - clocks		: CAN functional clock phandle. This property is as per the
 			  binding,
 			  Documentation/devicetree/bindings/clock/ti,sci-clk.txt
Documentation/devicetree/bindings/remoteproc/ti,keystone-rproc.txt +1 -1
index 461dc1d8d570..e99123c1445e 100644
@@ -82,7 +82,7 @@ The following are mandatory properties for Keystone 2 66AK2G SoCs only:
 - power-domains:	Should contain a phandle to a PM domain provider node
 			and an args specifier containing the DSP device id
 			value. This property is as per the binding,
-			Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+			Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 
 Optional properties:
 --------------------
Documentation/devicetree/bindings/usb/ti,j721e-usb.yaml +1 -1
index 7ec87a783c5c..a634774c537c 100644
@@ -27,7 +27,7 @@ properties:
     description:
       PM domain provider node and an args specifier containing
       the USB device id value. See,
-      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
     maxItems: 1
 
   clocks:
Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml +1 -1
index 9a068d3bc73b..f6e91a5fd8fe 100644
@@ -47,7 +47,7 @@ properties:
     description: Should contain a phandle to a PM domain provider node
       and an args specifier containing the USB device id
       value. This property is as per the binding,
-      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+      Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 
   phys:
     maxItems: 1
MAINTAINERS +1 -1
index a2517768404a..0f0a01b54c1b 100644
@@ -18197,7 +18197,7 @@ F:	Documentation/devicetree/bindings/clock/ti,sci-clk.txt
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml
 F:	Documentation/devicetree/bindings/reset/ti,sci-reset.txt
-F:	Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
+F:	Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 F:	drivers/clk/keystone/sci-clk.c
 F:	drivers/firmware/ti_sci*
 F:	drivers/irqchip/irq-ti-sci-inta.c
Signature · 1 line
2.31.1
#11 lore raw

PATCH 5/12 dt-bindings: reset: update ti,sci-reset.yaml references

In reply to Mauro Carvalho Chehab

Changeset 9a81b8cbc245 ("dt-bindings: reset: Convert ti,sci-reset to json schema")
renamed: Documentation/devicetree/bindings/reset/ti,sci-reset.txt
to: Documentation/devicetree/bindings/reset/ti,sci-reset.yaml.

Update the cross-references accordingly.

Fixes 9a81b8cbc245 ("dt-bindings: reset: Convert ti,sci-reset to json schema")
---
 .../devicetree/bindings/remoteproc/ti,keystone-rproc.txt        | 2 +-
 MAINTAINERS                                                     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
Documentation/devicetree/bindings/remoteproc/ti,keystone-rproc.txt +1 -1
index e99123c1445e..463a97c11eff 100644
@@ -48,7 +48,7 @@ The following are the mandatory properties:
 			bindings for the reset argument specifier as per SoC,
 			Documentation/devicetree/bindings/reset/ti-syscon-reset.txt
 			    for 66AK2HK/66AK2L/66AK2E SoCs or,
-			Documentation/devicetree/bindings/reset/ti,sci-reset.txt
+			Documentation/devicetree/bindings/reset/ti,sci-reset.yaml
 			    for 66AK2G SoCs
 
 - interrupts: 		Should contain an entry for each value in 'interrupt-names'.
MAINTAINERS +1 -1
index 790eff88b53e..2800307082a9 100644
@@ -18196,7 +18196,7 @@ F:	Documentation/devicetree/bindings/arm/keystone/ti,sci.txt
 F:	Documentation/devicetree/bindings/clock/ti,sci-clk.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-inta.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/ti,sci-intr.yaml
-F:	Documentation/devicetree/bindings/reset/ti,sci-reset.txt
+F:	Documentation/devicetree/bindings/reset/ti,sci-reset.yaml
 F:	Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml
 F:	drivers/clk/keystone/sci-clk.c
 F:	drivers/firmware/ti_sci*
Signature · 1 line
2.31.1
#16 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Mauro Carvalho Chehab
Quoted 18 lines · Mauro Carvalho Chehab

When :doc: is used, the .rst should be removed. Also, the patches are relative to the current directory.

So, the right reference should be:

:doc:/accounting/delay-accounting

Fixes fcb501704554 ("delayacct: Document task_delayacct sysctl")
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +0 -0
index b2057173fe07..7f36cba3204b 100644

Documentation/admin-guide/sysctl/kernel.rst task_delayacct · line 1100

Quoted 5 lines
Documentation/admin-guide/sysctl/kernel.rst +1 -1
@@ -1097,7 +1097,7 @@ task_delayacct
 ===============
 
 Enables/disables task delay accounting (see
-:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
+:doc:`/accounting/delay-accounting`). Enabling this feature incurs

This breaks any chance of using 'goto file' like features in text editors :/ Can we please not do crap like this.

#17 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

Em Wed, 2 Jun 2021 18:38:29 +0200
Peter Zijlstra <[email protected]> escreveu:

Quoted 21 lines · Mauro Carvalho Chehab
Quoted 20 lines

When :doc: is used, the .rst should be removed. Also, the patches are relative to the current directory.

So, the right reference should be:

:doc:/accounting/delay-accounting

Fixes fcb501704554 ("delayacct: Document task_delayacct sysctl")
---
 Documentation/admin-guide/sysctl/kernel.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/admin-guide/sysctl/kernel.rst +0 -0
index b2057173fe07..7f36cba3204b 100644
@@ -1097,7 +1097,7 @@ task_delayacct
 ===============
 
Quoted 6 lines

Documentation/admin-guide/sysctl/kernel.rst task_delayacct · line 1100

Quoted 3 lines
Documentation/admin-guide/sysctl/kernel.rst +1 -1
 Enables/disables task delay accounting (see
-:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
+:doc:`/accounting/delay-accounting`). Enabling this feature incurs  

This breaks any chance of using 'goto file' like features in text editors :/

This is a feature of your favorite text editor. Not all have it.

Quoted 1 line

Can we please not do crap like this.

See, this is not the only place on this document using :doc:``. It is just the one using it wrong:

	$ git grep :doc: Documentation/admin-guide/sysctl/kernel.rst
	Documentation/admin-guide/sysctl/kernel.rst:For general info and legal blurb, please look in :doc:`index`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/power/video`. This allows the video resume mode to be set,
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/x86/boot` for additional information.
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/x86/boot` for additional information.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/driver-api/firmware/fallback-mechanisms`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/trace/ftrace`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/lockup-watchdogs` for more information.
	Documentation/admin-guide/sysctl/kernel.rst:to the guest kernel command line (see :doc:`/admin-guide/kernel-parameters`).
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/initrd`.
	Documentation/admin-guide/sysctl/kernel.rst::doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/userspace-api/seccomp_filter`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/sysrq`.
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/tainted-kernels` for more information.
	Documentation/admin-guide/sysctl/kernel.rst:  See :doc:`/admin-guide/kernel-parameters` for more details on that particular
	Documentation/admin-guide/sysctl/kernel.rst:When set, disables tracing (see :doc:`/trace/ftrace`) when a
	Documentation/admin-guide/sysctl/kernel.rst:See :doc:`/admin-guide/kernel-parameters` and
	Documentation/admin-guide/sysctl/kernel.rst::doc:`/trace/boottime-trace`.

-

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

Tests are needed, though, to be sure that automarkup.py won't miss something, as the regex there might require tweaks to cover some border cases.

Thanks,
Mauro

#18 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

Quoted 5 lines · Mauro Carvalho Chehab

Em Wed, 2 Jun 2021 18:38:29 +0200
Peter Zijlstra <[email protected]> escreveu:

Quoted 1 line · Mauro Carvalho Chehab
Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

Enables/disables task delay accounting (see
-:doc:accounting/delay-accounting.rst). Enabling this feature incurs +:doc:/accounting/delay-accounting). Enabling this feature incurs

This breaks any chance of using 'goto file' like features in text editors :/

This is a feature of your favorite text editor. Not all have it.

Afaict both vim (gf) and emacs (M-x ffap) can do this. That covers about 99% of all sane editors no? :-)

Quoted 4 lines

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

That sounds good, thanks!

maintainer
#19 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Mauro Carvalho Chehab
Quoted 4 lines · Mauro Carvalho Chehab

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

That seems like the right approach to me. We have the automarkup capability, we might as well make use of it...

Thanks,

jon

#20 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

Em Wed, 2 Jun 2021 20:29:23 +0200
Peter Zijlstra <[email protected]> escreveu:

Quoted 8 lines
Quoted 8 lines

Peter Zijlstra <[email protected]> escreveu:

Quoted 6 lines · Mauro Carvalho Chehab
Quoted 4 lines

Enables/disables task delay accounting (see
-:doc:accounting/delay-accounting.rst). Enabling this feature incurs +:doc:/accounting/delay-accounting). Enabling this feature incurs

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

This breaks any chance of using 'goto file' like features in text editors :/

This is a feature of your favorite text editor. Not all have it.

Afaict both vim (gf) and emacs (M-x ffap) can do this. That covers about 99% of all sane editors no? :-)

Heh, not quite ;-) Here, I use nano(/pico), from the old times where (al)pine was my emailer. I can live with vim, but I prefer an editor that starts in editing mode.

I tried to use emacs a few times, but my fingers are too much into pico/nano control keys, so it was ending by making me typing a lot slower. Besides that, nano works well on 99% of my daily needs.

When I need more fancy, like regex substitutions, changing/moving big code blocks, editing multiple files at the same time, etc, then I just use a GUI editor (currently kate, but seeking for a good replacement, as some changes during F33 times - still present on F34 - caused some regressions).

Em Wed, 02 Jun 2021 12:36:05 -0600
Jonathan Corbet <[email protected]> escreveu:

Quoted 7 lines
Quoted 4 lines

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

That seems like the right approach to me. We have the automarkup capability, we might as well make use of it...

Ok, I'll prepare a separate patch series addressing it.

-

Jon,

With regards to the :doc: -> Documentation/ conversion, I guess I'll do it on an independent patch series against your docs-next tree.

Then, I'll send a separate patch series after 5.14-rc1 in order to address the stuff under linux-next.

Thanks,
Mauro

maintainer Applied
#6 lore raw

Re: [PATCH 03/12] dt-bindings: soc: ti: update sci-pm-domain.yaml references

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
renamed: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
to: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml.

Update the cross-references accordingly.

Fixes fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
Quoted 11 lines
---
 Documentation/devicetree/bindings/dma/ti-edma.txt             | 4 ++--
 Documentation/devicetree/bindings/i2c/i2c-davinci.txt         | 2 +-
 Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt       | 2 +-
 Documentation/devicetree/bindings/net/can/c_can.txt           | 2 +-
 .../devicetree/bindings/remoteproc/ti,keystone-rproc.txt      | 2 +-
 Documentation/devicetree/bindings/usb/ti,j721e-usb.yaml       | 2 +-
 Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml   | 2 +-
 MAINTAINERS                                                   | 2 +-
 8 files changed, 9 insertions(+), 9 deletions(-)

Applied, thanks!

maintainer Applied
#9 lore raw

Re: [PATCH 04/12] dt-bindings: clock: update ti,sci-clk.yaml references

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
renamed: Documentation/devicetree/bindings/clock/ti,sci-clk.txt
to: Documentation/devicetree/bindings/clock/ti,sci-clk.yaml.

Update the cross-references accordingly.

Fixes a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
Quoted 9 lines
---
 Documentation/devicetree/bindings/gpio/gpio-davinci.txt | 2 +-
 Documentation/devicetree/bindings/i2c/i2c-davinci.txt   | 2 +-
 Documentation/devicetree/bindings/mmc/ti-omap-hsmmc.txt | 2 +-
 Documentation/devicetree/bindings/net/can/c_can.txt     | 2 +-
 Documentation/devicetree/bindings/spi/spi-davinci.txt   | 2 +-
 MAINTAINERS                                             | 2 +-
 6 files changed, 6 insertions(+), 6 deletions(-)

Applied, thanks!

maintainer Applied
#12 lore raw

Re: [PATCH 05/12] dt-bindings: reset: update ti,sci-reset.yaml references

In reply to Mauro Carvalho Chehab
Quoted 4 lines · Mauro Carvalho Chehab

Changeset 9a81b8cbc245 ("dt-bindings: reset: Convert ti,sci-reset to json schema")
renamed: Documentation/devicetree/bindings/reset/ti,sci-reset.txt
to: Documentation/devicetree/bindings/reset/ti,sci-reset.yaml.

Quoted 9 lines

Update the cross-references accordingly.

Fixes 9a81b8cbc245 ("dt-bindings: reset: Convert ti,sci-reset to json schema")
---
 .../devicetree/bindings/remoteproc/ti,keystone-rproc.txt        | 2 +-
 MAINTAINERS                                                     | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Applied, thanks!

maintainer Applied
#14 lore raw

Re: [PATCH 06/12] dt-bindings: iio: io-channel-mux.yaml: fix a typo

In reply to Mauro Carvalho Chehab
Quoted 11 lines · Mauro Carvalho Chehab

The file name: Documentation/device-tree/bindings/mux/mux-controller.yaml should be, instead: Documentation/devicetree/bindings/mux/mux-controller.yaml.

Update its cross-reference accordingly.

Fixes a66cec598f49 ("dt-bindings: iio: multiplexer: Convert io-channel-mux bindings to DT schema")
---
 .../devicetree/bindings/iio/multiplexer/io-channel-mux.yaml     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks!

maintainer Applied
#4 lore raw

Re: [PATCH 02/12] dt-bindings: power: supply: cpcap-charger: update cpcap-charger.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 4 lines · Mauro Carvalho Chehab

Changeset ce49e4282200 ("dt-bindings: power: supply: cpcap-charger: Convert to DT schema format")
renamed: Documentation/devicetree/bindings/power/supply/cpcap-charger.txt
to: Documentation/devicetree/bindings/power/supply/cpcap-charger.yaml.

Quoted 8 lines

Update its cross-reference accordingly.

Fixes ce49e4282200 ("dt-bindings: power: supply: cpcap-charger: Convert to DT schema format")
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks!

maintainer Applied
#2 lore raw

Re: [PATCH 01/12] dt-bindings: power: supply: cpcap-battery: update cpcap-battery.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 4 lines · Mauro Carvalho Chehab

Changeset 3c5be0454972 ("dt-bindings: power: supply: cpcap-battery: Convert to DT schema format")
renamed: Documentation/devicetree/bindings/power/supply/cpcap-battery.txt
to: Documentation/devicetree/bindings/power/supply/cpcap-battery.yaml.

Quoted 8 lines

Update its cross-reference accordingly.

Fixes 3c5be0454972 ("dt-bindings: power: supply: cpcap-battery: Convert to DT schema format")
---
 Documentation/devicetree/bindings/mfd/motorola-cpcap.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Applied, thanks!

maintainer Applied
#29 lore raw

Re: [PATCH 09/12] MAINTAINERS: update marvell,armada-3700-utmi-phy.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 5 lines · Mauro Carvalho Chehab

Changeset 6569d8386388 ("dt-bindings: phy: convert phy-mvebu-utmi to YAML schema")
renamed: Documentation/devicetree/bindings/phy/phy-mvebu-utmi.txt
to: Documentation/devicetree/bindings/phy/marvell,armada-3700-utmi-phy.yaml.

Update its cross-reference accordingly.

Applied, thanks

Signature · 1 line
~Vinod
#21 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Mauro Carvalho Chehab
Quoted 9 lines · Mauro Carvalho Chehab

Em Wed, 2 Jun 2021 20:29:23 +0200
Peter Zijlstra <[email protected]> escreveu:

Quoted 2 lines

Afaict both vim (gf) and emacs (M-x ffap) can do this. That covers about 99% of all sane editors no? :-)

Heh, not quite ;-) Here, I use nano(/pico), from the old times where (al)pine was my emailer. I can live with vim, but I prefer an editor that starts in editing mode.

echo "startinsert" >> ~/.vimrc

Quoted 6 lines

I tried to use emacs a few times, but my fingers are too much into pico/nano control keys, so it was ending by making me typing a lot slower. Besides that, nano works well on 99% of my daily needs.

When I need more fancy, like regex substitutions, changing/moving big code blocks, editing multiple files at the same time, etc,

nano can in fact do the multi-file thing, see nano -F, or add "set multibuffer" to nanorc.

Quoted 3 lines

then I just use a GUI editor (currently kate, but seeking for a good replacement, as some changes during F33 times - still present on F34 - caused some regressions).

The fact that you need a second editor; and are looking for a replacement disqualifies nano (and Kate for that matter) as a sane editor IMO.

You can ofcourse start extending nano :-)

#22 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Mauro Carvalho Chehab

Em Wed, 2 Jun 2021 22:19:40 +0200
Mauro Carvalho Chehab <[email protected]> escreveu:

Quoted 44 lines

Em Wed, 2 Jun 2021 20:29:23 +0200
Peter Zijlstra <[email protected]> escreveu:

Quoted 8 lines
Quoted 8 lines

Peter Zijlstra <[email protected]> escreveu:

Quoted 6 lines · Mauro Carvalho Chehab
Quoted 4 lines

Enables/disables task delay accounting (see
-:doc:accounting/delay-accounting.rst). Enabling this feature incurs +:doc:/accounting/delay-accounting). Enabling this feature incurs

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

This breaks any chance of using 'goto file' like features in text editors :/

This is a feature of your favorite text editor. Not all have it.

Afaict both vim (gf) and emacs (M-x ffap) can do this. That covers about 99% of all sane editors no? :-)

Heh, not quite ;-) Here, I use nano(/pico), from the old times where (al)pine was my emailer. I can live with vim, but I prefer an editor that starts in editing mode.

I tried to use emacs a few times, but my fingers are too much into pico/nano control keys, so it was ending by making me typing a lot slower. Besides that, nano works well on 99% of my daily needs.

When I need more fancy, like regex substitutions, changing/moving big code blocks, editing multiple files at the same time, etc, then I just use a GUI editor (currently kate, but seeking for a good replacement, as some changes during F33 times - still present on F34 - caused some regressions).

Em Wed, 02 Jun 2021 12:36:05 -0600
Jonathan Corbet <[email protected]> escreveu:

Quoted 7 lines
Quoted 4 lines

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

That seems like the right approach to me. We have the automarkup capability, we might as well make use of it...

Quoted 8 lines

Ok, I'll prepare a separate patch series addressing it.

-

Jon,

With regards to the :doc: -> Documentation/ conversion, I guess I'll do it on an independent patch series against your docs-next tree.

A pure replace of two patterns:

	:doc:\`(/[^\`]+)\`
	:doc:\`([^\`\<]+)\`

Produced this result:

 Documentation/PCI/endpoint/pci-endpoint-cfs.rst                             |  2 +-
 Documentation/PCI/pci.rst                                                   |  6 +++---
 Documentation/admin-guide/hw-vuln/special-register-buffer-data-sampling.rst |  2 +-
 Documentation/admin-guide/media/bt8xx.rst                                   |  8 ++++----
 Documentation/admin-guide/media/bttv.rst                                    | 14 +++++++-------
 Documentation/admin-guide/media/index.rst                                   |  4 ++--
 Documentation/admin-guide/media/saa7134.rst                                 |  2 +-
 Documentation/admin-guide/pm/intel_idle.rst                                 | 10 +++++-----
 Documentation/admin-guide/pm/intel_pstate.rst                               |  4 ++--
 Documentation/admin-guide/sysctl/abi.rst                                    |  2 +-
 Documentation/admin-guide/sysctl/kernel.rst                                 | 32 ++++++++++++++++----------------
 Documentation/block/biodoc.rst                                              |  2 +-
 Documentation/bpf/bpf_lsm.rst                                               |  4 ++--
 Documentation/core-api/bus-virt-phys-mapping.rst                            |  2 +-
 Documentation/core-api/dma-api.rst                                          |  4 ++--
 Documentation/core-api/dma-isa-lpc.rst                                      |  2 +-
 Documentation/core-api/index.rst                                            |  4 ++--
 Documentation/dev-tools/kunit/api/index.rst                                 |  2 +-
 Documentation/dev-tools/kunit/faq.rst                                       |  2 +-
 Documentation/dev-tools/kunit/index.rst                                     | 14 +++++++-------
 Documentation/dev-tools/kunit/start.rst                                     |  6 +++---
 Documentation/dev-tools/kunit/tips.rst                                      |  4 ++--
 Documentation/dev-tools/kunit/usage.rst                                     |  6 +++---
 Documentation/dev-tools/testing-overview.rst                                |  4 ++--
 Documentation/devicetree/bindings/submitting-patches.rst                    |  2 +-
 Documentation/doc-guide/contributing.rst                                    |  8 ++++----
 Documentation/driver-api/gpio/using-gpio.rst                                |  4 ++--
 Documentation/driver-api/ioctl.rst                                          |  2 +-
 Documentation/driver-api/media/drivers/bttv-devel.rst                       |  2 +-
 Documentation/driver-api/media/index.rst                                    |  4 ++--
 Documentation/driver-api/pm/devices.rst                                     |  2 +-
 Documentation/driver-api/surface_aggregator/clients/index.rst               |  2 +-
 Documentation/driver-api/surface_aggregator/internal.rst                    |  6 +++---
 Documentation/driver-api/surface_aggregator/overview.rst                    |  4 ++--
 Documentation/driver-api/usb/dma.rst                                        |  6 +++---
 Documentation/firmware-guide/acpi/dsd/data-node-references.rst              |  2 +-
 Documentation/firmware-guide/acpi/dsd/graph.rst                             |  2 +-
 Documentation/firmware-guide/acpi/enumeration.rst                           |  2 +-
 Documentation/hwmon/adm1177.rst                                             |  2 +-
 Documentation/i2c/instantiating-devices.rst                                 |  2 +-
 Documentation/i2c/old-module-parameters.rst                                 |  2 +-
 Documentation/i2c/smbus-protocol.rst                                        |  2 +-
 Documentation/kernel-hacking/hacking.rst                                    |  4 ++--
 Documentation/networking/devlink/devlink-region.rst                         |  2 +-
 Documentation/networking/devlink/devlink-trap.rst                           |  4 ++--
 Documentation/process/submitting-patches.rst                                | 12 ++++++------
 Documentation/security/landlock.rst                                         |  2 +-
 Documentation/trace/coresight/coresight.rst                                 |  6 +++---
 Documentation/trace/ftrace.rst                                              |  2 +-
 Documentation/translations/it_IT/core-api/symbol-namespaces.rst             |  2 +-
 Documentation/translations/it_IT/kernel-hacking/hacking.rst                 |  4 ++--
 Documentation/translations/it_IT/process/email-clients.rst                  |  2 +-
 Documentation/translations/it_IT/process/management-style.rst               |  2 +-
 Documentation/translations/it_IT/process/submitting-patches.rst             | 14 +++++++-------
 Documentation/translations/it_IT/riscv/patch-acceptance.rst                 |  2 +-
 Documentation/translations/zh_CN/admin-guide/bug-bisect.rst                 |  2 +-
 Documentation/translations/zh_CN/admin-guide/bug-hunting.rst                |  2 +-
 Documentation/translations/zh_CN/admin-guide/index.rst                      |  2 +-
 Documentation/translations/zh_CN/admin-guide/init.rst                       |  2 +-
 Documentation/translations/zh_CN/admin-guide/security-bugs.rst              |  2 +-
 Documentation/translations/zh_CN/admin-guide/tainted-kernels.rst            |  2 +-
 Documentation/translations/zh_CN/core-api/index.rst                         |  6 +++---
 Documentation/translations/zh_CN/core-api/irq/concepts.rst                  |  2 +-
 Documentation/translations/zh_CN/core-api/irq/index.rst                     |  2 +-
 Documentation/translations/zh_CN/core-api/irq/irq-affinity.rst              |  2 +-
 Documentation/translations/zh_CN/core-api/irq/irq-domain.rst                |  2 +-
 Documentation/translations/zh_CN/core-api/irq/irqflags-tracing.rst          |  2 +-
 Documentation/translations/zh_CN/cpu-freq/core.rst                          |  2 +-
 Documentation/translations/zh_CN/cpu-freq/cpu-drivers.rst                   |  2 +-
 Documentation/translations/zh_CN/cpu-freq/cpufreq-stats.rst                 |  2 +-
 Documentation/translations/zh_CN/cpu-freq/index.rst                         |  2 +-
 Documentation/translations/zh_CN/filesystems/debugfs.rst                    |  2 +-
 Documentation/translations/zh_CN/iio/ep93xx_adc.rst                         |  2 +-
 Documentation/translations/zh_CN/iio/iio_configfs.rst                       |  2 +-
 Documentation/translations/zh_CN/iio/index.rst                              |  2 +-
 Documentation/translations/zh_CN/mips/booting.rst                           |  2 +-
 Documentation/translations/zh_CN/mips/features.rst                          |  2 +-
 Documentation/translations/zh_CN/mips/index.rst                             |  2 +-
 Documentation/translations/zh_CN/mips/ingenic-tcu.rst                       |  2 +-
 Documentation/translations/zh_CN/openrisc/index.rst                         |  2 +-
 Documentation/translations/zh_CN/openrisc/openrisc_port.rst                 |  2 +-
 Documentation/translations/zh_CN/openrisc/todo.rst                          |  2 +-
 Documentation/translations/zh_CN/riscv/boot-image-header.rst                |  2 +-
 Documentation/translations/zh_CN/riscv/index.rst                            |  2 +-
 Documentation/translations/zh_CN/riscv/patch-acceptance.rst                 |  2 +-
 Documentation/translations/zh_CN/riscv/pmu.rst                              |  2 +-
 Documentation/translations/zh_CN/sound/hd-audio/index.rst                   |  2 +-
 Documentation/translations/zh_CN/sound/index.rst                            |  2 +-
 Documentation/userspace-api/landlock.rst                                    |  8 ++++----
 Documentation/userspace-api/media/glossary.rst                              |  2 +-
 Documentation/userspace-api/media/index.rst                                 |  4 ++--
 Documentation/virt/kvm/s390-pv-boot.rst                                     |  2 +-
 Documentation/x86/boot.rst                                                  |  4 ++--
 Documentation/x86/mtrr.rst                                                  |  2 +-
 94 files changed, 174 insertions(+), 174 deletions(-)

Some manual work is needed, as a couple of replacements occurred inside tables. I also need to check if automarkup.py got everything, including the ones inside tables.

I'm in doubt with regards to translations. There, the tag is used to point to the original translation, like on Documentation/translations/it_IT/core-api/symbol-namespaces.rst:

	:Original: :doc:`../../../core-api/symbol-namespaces`
	:Translator: Federico Vaga <[email protected]>

My personal preference would be to keep using it for translations.

There are, however, two special cases:

1. Named cross-references with a documentation path:

	:doc:`Non-Transparent Bridge <../../driver-api/ntb>`

As the end result (in html) would be something like:

	<a href="../../driver-api/ntb.html>Non-Transparent Bridge</a>

We might just ignore the name and convert it into:

Documentation/driver-api/ntb.rst

but this sounds a bad idea on my eyes, as some context can be missed.

So, I would keep using :doc: on such cases.

2. Named cross-references without a path:

:doc: AMDGPU RAS Reboot Behavior for Unrecoverable Errors

This actually guides to a kernel-doc markup inside a C file:

drivers/gpu/drm/amd/amdgpu/amdgpu_ras.c: * DOC: AMDGPU RAS Reboot Behavior for Unrecoverable Errors

So, those can't be converted.

The net result is that a warning at checkpatch.pl about the usage of :doc: would need to exclude those special cases.

Thanks,
Mauro

Reviewed-by on v1 12/12
#34 lore raw

Re: [EXT] [PATCH 12/12] MAINTAINERS: update nxp,imx8-jpeg.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 31 lines · Mauro Carvalho Chehab

The file name: Documentation/devicetree/bindings/media/imx8-jpeg.yaml should be, instead: Documentation/devicetree/bindings/media/nxp,imx8- jpeg.yaml.

Update its cross-reference accordingly.

Fixes be157db0a3d8 ("media: Add maintainer for IMX jpeg v4l2

driver")

Fixes b16ed1e66008 ("media: dt-bindings: Add bindings for

i.MX8QXP/QM JPEG driver")

---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +0 -0
index a737ba26bdcd..37baabb1e7a5 100644
@@ -13303,7 +13303,7 @@ M:      Mirela Rabulea <

[email protected]>

 R:     NXP Linux Team <[email protected]>
 L:     [email protected]
 S:     Maintained
MAINTAINERS +1 -2
-F:     Documentation/devicetree/bindings/media/imx8-jpeg.yaml
+F:     Documentation/devicetree/bindings/media/nxp,imx8-jpeg.yaml
 F:     drivers/media/platform/imx-jpeg
 
 NZXT-KRAKEN2 HARDWARE MONITORING DRIVER
--
Quoted 2 lines

2.31.1

Hi,
thanks for catching this up.

Regards,
Mirela

#24 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Jonathan Corbet

Em Wed, 02 Jun 2021 12:36:05 -0600
Jonathan Corbet <[email protected]> escreveu:

Quoted 9 lines
Quoted 4 lines · Mauro Carvalho Chehab

That's said, automarkup.py has a rule to convert Documentation/<foo>.rst into :doc:<foo>. So, an alternative approach would be to convert treewide all :doc:<foo> into Documentation/<foo>.rst and add something at checkpatch.pl to recommend to avoid :doc: notation.

That seems like the right approach to me. We have the automarkup capability, we might as well make use of it...

Hmm...

This patch caused a regression:

<patch>
PATCH] media: admin-guide: avoid using ReSt :doc:foo markup

The :doc:foo tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:foo.

Documentation/admin-guide/media/index.rst +2 -2
index 6e0d2bae7154..5dbf6d02096a 100644
@@ -11,10 +11,10 @@ its supported drivers.
 
 Please see:
 
-- :doc:`/userspace-api/media/index`
+- Documentation/userspace-api/media/index.rst
      for the userspace APIs used on media devices.
 
-- :doc:`/driver-api/media/index`
+- Documentation/driver-api/media/index.rst
      for driver development information and Kernel APIs used by
      media devices;

</patch>

This is the diff for the HTML output:

<diff>

admin-guide/media/index.html +2 -2
index 94c0cdf51579..28c083b75896 100644
@@ -339,12 +339,12 @@ its supported drivers.</p>
 <p>Please see:</p>
 <ul class="simple">
 <li><dl class="simple">
-<dt><a class="reference internal" href="../../userspace-api/media/index.html"><span class="doc">Linux Media Infrastructure userspace API</span></a></dt><dd><p>for the userspace APIs used on media devices.</p>
+<dt>Documentation/userspace-api/media/index.rst</dt><dd><p>for the userspace APIs used on media devices.</p>
 </dd>
 </dl>
 </li>
 <li><dl class="simple">
-<dt><a class="reference internal" href="../../driver-api/media/index.html"><span class="doc">Media subsystem kernel internal API</span></a></dt><dd><p>for driver development information and Kernel APIs used by
+<dt>Documentation/driver-api/media/index.rst</dt><dd><p>for driver development information and Kernel APIs used by
 media devices;</p>
 </dd>
 </dl>

</diff>

It sounds that automarkup.py ignored it. Maybe because it is inside a list?

Thanks,
Mauro

#35 lore raw
In reply to Mauro Carvalho Chehab
Quoted 5 lines · Mauro Carvalho Chehab

There are some broken references at today's linux-next with regards to files inside Documentation/.

Address them.

I've finally added this to my automated checks, so now anyone that breaks this on binding schema patches should get notified (with the exception of patches not Cc'ed to the DT list).

Rob

Acked-by on v1 3/12
#7 lore raw

Re: [PATCH 03/12] dt-bindings: soc: ti: update sci-pm-domain.yaml references

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
renamed: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.txt
to: Documentation/devicetree/bindings/soc/ti/sci-pm-domain.yaml.

Update the cross-references accordingly.

Fixes fda55c7256fe ("dt-bindings: soc: ti: Convert ti,sci-pm-domain to json schema")
Acked-by on v1 4/12
#10 lore raw

Re: [PATCH 04/12] dt-bindings: clock: update ti,sci-clk.yaml references

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
renamed: Documentation/devicetree/bindings/clock/ti,sci-clk.txt
to: Documentation/devicetree/bindings/clock/ti,sci-clk.yaml.

Update the cross-references accordingly.

Fixes a7dbfa6f3877 ("dt-bindings: clock: Convert ti,sci-clk to json schema")
Acked-by on v1 8/12
#26 lore raw

Re: [PATCH 08/12] MAINTAINERS: update faraday,ftrtc010.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
renamed: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
to: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml.

Update its cross-reference accordingly.

Fixes 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")

Yours,
Linus Walleij

Acked-by on v1 8/12
#27 lore raw

Re: [PATCH 08/12] MAINTAINERS: update faraday,ftrtc010.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 8 lines · Mauro Carvalho Chehab

Changeset 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
renamed: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
to: Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml.

Update its cross-reference accordingly.

Fixes 8df65d4adca6 ("dt-bindings: convert rtc/faraday,ftrtc01 to yaml")
Quoted 20 lines
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -1
index 2800307082a9..8b423b7246a3 100644
@@ -1818,7 +1818,7 @@ T:	git git://github.com/ulli-kroll/linux.git
 F:	Documentation/devicetree/bindings/arm/gemini.txt
 F:	Documentation/devicetree/bindings/net/cortina,gemini-ethernet.txt
 F:	Documentation/devicetree/bindings/pinctrl/cortina,gemini-pinctrl.txt
-F:	Documentation/devicetree/bindings/rtc/faraday,ftrtc010.txt
+F:	Documentation/devicetree/bindings/rtc/faraday,ftrtc010.yaml
 F:	arch/arm/mach-gemini/
 F:	drivers/net/ethernet/cortina/
 F:	drivers/pinctrl/pinctrl-gemini.c
Signature · 1 line
2.31.1
Signature · 3 lines
Alexandre Belloni, co-owner and COO, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#31 lore raw

Re: [PATCH 10/12] MAINTAINERS: update ti,omap-gpio.yaml reference

In reply to Mauro Carvalho Chehab
Quoted 27 lines · Mauro Carvalho Chehab

Changeset bc3aca5393c4 ("dt-bindings: gpio: omap: Convert to json-schema")
renamed: Documentation/devicetree/bindings/gpio/gpio-omap.txt
to: Documentation/devicetree/bindings/gpio/ti,omap-gpio.yaml.

Update its cross-reference accordingly.

Fixes bc3aca5393c4 ("dt-bindings: gpio: omap: Convert to json-schema")
---
 MAINTAINERS | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
MAINTAINERS +1 -2
index 644572ab4b2d..7d65784df8c8 100644
@@ -13412,7 +13412,7 @@ M:      Santosh Shilimkar <[email protected]>
 M:     Kevin Hilman <[email protected]>
 L:     [email protected]
 S:     Maintained
-F:     Documentation/devicetree/bindings/gpio/gpio-omap.txt
+F:     Documentation/devicetree/bindings/gpio/ti,omap-gpio.yaml
 F:     drivers/gpio/gpio-omap.c
 
 OMAP HARDWARE SPINLOCK SUPPORT
--
Quoted 2 lines

2.31.1

Applied, thanks!

Bartosz

#23 lore raw

Re: [PATCH 07/12] docs: accounting: update delay-accounting.rst reference

In reply to Mauro Carvalho Chehab

Hi Mauro,

and sorry for the late reply

Quoted 4 lines · Mauro Carvalho Chehab

Some manual work is needed, as a couple of replacements occurred inside tables. I also need to check if automarkup.py got everything, including the ones inside tables.

Quoted 8 lines

I'm in doubt with regards to translations. There, the tag is used to point to the original translation, like on Documentation/translations/it_IT/core-api/symbol-namespaces.rst:

	:Original: :doc:`../../../core-api/symbol-namespaces`
	:Translator: Federico Vaga <[email protected]>

My personal preference would be to keep using it for translations.

Why is this your preference? I would prefer to have a consistent style everywhere. If ":doc:" is now discouraged, then do not use it. What am I missing?

Signature · 1 line
Federico Vaga