2021-09-16 09:15:48

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 00/24] Fix some issues at documentation

Hi John,

The first patch in this series fix a bad character used instead of
a "(c)" UTF-8 symbol.

The remaining ones fix several broken references to files
under Documentation/, several due to DT schema conversions
from .txt to .yaml.

Mauro Carvalho Chehab (24):
visorbus: fix a copyright symbol that was bad encoded
dt-bindings: net: dsa: sja1105: update nxp,sja1105.yaml reference
dt-bindings: arm: mediatek: mmsys: update mediatek,mmsys.yaml
reference
dt-bindings: w1: update w1-gpio.yaml reference
dt-bindings: mmc: update mmc-card.yaml reference
libbpf: update index.rst reference
docs: accounting: update delay-accounting.rst reference
tools: bpftool: update bpftool-prog.rst reference
tools: bpftool: update bpftool-map.rst reference
bpftool: update bpftool-cgroup.rst reference
MAINTAINERS: update mtd-physmap.yaml reference
MAINTAINERS: update arm,vic.yaml reference
MAINTAINERS: update aspeed,i2c.yaml reference
MAINTAINERS: update faraday,ftrtc010.yaml reference
MAINTAINERS: update fsl,fec.yaml reference
MAINTAINERS: update mtd-physmap.yaml reference
MAINTAINERS: update ti,am654-hbmc.yaml reference
MAINTAINERS: update ti,sci.yaml reference
MAINTAINERS: update intel,ixp46x-rng.yaml reference
MAINTAINERS: update nxp,imx8-jpeg.yaml reference
MAINTAINERS: update gemini.yaml reference
MAINTAINERS: update brcm,unimac-mdio.yaml reference
MAINTAINERS: update chipone,icn8318.yaml reference
MAINTAINERS: update silergy,sy8106a.yaml reference

Documentation/admin-guide/sysctl/kernel.rst | 2 +-
Documentation/bpf/index.rst | 2 +-
.../display/mediatek/mediatek,disp.txt | 2 +-
Documentation/networking/dsa/sja1105.rst | 2 +-
Documentation/w1/masters/w1-gpio.rst | 2 +-
MAINTAINERS | 28 +++++++++----------
drivers/mmc/host/omap_hsmmc.c | 2 +-
drivers/visorbus/visorbus_main.c | 2 +-
.../selftests/bpf/test_bpftool_synctypes.py | 6 ++--
9 files changed, 24 insertions(+), 24 deletions(-)

--
2.31.1



2021-09-16 09:15:53

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 13/24] MAINTAINERS: update aspeed,i2c.yaml reference

Changeset 810e4441946c ("dt-bindings: aspeed-i2c: Convert txt to yaml format")
renamed: Documentation/devicetree/bindings/i2c/i2c-aspeed.txt
to: Documentation/devicetree/bindings/i2c/aspeed,i2c.yaml.

Update its cross-reference accordingly.

Fixes: 810e4441946c ("dt-bindings: aspeed-i2c: Convert txt to yaml format")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index f02d1c94a219..d0f4fe1481da 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1745,7 +1745,7 @@ R: Joel Stanley <[email protected]>
L: [email protected]
L: [email protected] (moderated for non-subscribers)
S: Maintained
-F: Documentation/devicetree/bindings/i2c/i2c-aspeed.txt
+F: Documentation/devicetree/bindings/i2c/aspeed,i2c.yaml
F: Documentation/devicetree/bindings/interrupt-controller/aspeed,ast2400-i2c-ic.txt
F: drivers/i2c/busses/i2c-aspeed.c
F: drivers/irqchip/irq-aspeed-i2c-ic.c
--
2.31.1

2021-09-16 09:16:26

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 22/24] MAINTAINERS: update brcm,unimac-mdio.yaml reference

Changeset 5d1c5594b646 ("dt-bindings: net: brcm,unimac-mdio: convert to the json-schema")
renamed: Documentation/devicetree/bindings/net/brcm,unimac-mdio.txt
to: Documentation/devicetree/bindings/net/brcm,unimac-mdio.yaml.

Update its cross-reference accordingly.

Fixes: 5d1c5594b646 ("dt-bindings: net: brcm,unimac-mdio: convert to the json-schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index de18144b8c52..adce2bdedb9e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3757,7 +3757,7 @@ L: [email protected]
L: [email protected]
S: Supported
F: Documentation/devicetree/bindings/net/brcm,bcmgenet.txt
-F: Documentation/devicetree/bindings/net/brcm,unimac-mdio.txt
+F: Documentation/devicetree/bindings/net/brcm,unimac-mdio.yaml
F: drivers/net/ethernet/broadcom/genet/
F: drivers/net/ethernet/broadcom/unimac.h
F: drivers/net/mdio/mdio-bcm-unimac.c
--
2.31.1

2021-09-16 09:16:29

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 02/24] dt-bindings: net: dsa: sja1105: update nxp,sja1105.yaml reference

Changeset 62568bdbe6f6 ("dt-bindings: net: dsa: sja1105: convert to YAML schema")
renamed: Documentation/devicetree/bindings/net/dsa/sja1105.txt
to: Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml.

Update its cross-reference accordingly.

Fixes: 62568bdbe6f6 ("dt-bindings: net: dsa: sja1105: convert to YAML schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/networking/dsa/sja1105.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/networking/dsa/sja1105.rst b/Documentation/networking/dsa/sja1105.rst
index 564caeebe2b2..29b1bae0cf00 100644
--- a/Documentation/networking/dsa/sja1105.rst
+++ b/Documentation/networking/dsa/sja1105.rst
@@ -296,7 +296,7 @@ not available.
Device Tree bindings and board design
=====================================

-This section references ``Documentation/devicetree/bindings/net/dsa/sja1105.txt``
+This section references ``Documentation/devicetree/bindings/net/dsa/nxp,sja1105.yaml``
and aims to showcase some potential switch caveats.

RMII PHY role and out-of-band signaling
--
2.31.1

2021-09-16 09:16:33

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 18/24] MAINTAINERS: update ti,sci.yaml reference

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")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 5154c8578ea4..bb9daad21935 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18546,7 +18546,7 @@ M: Santosh Shilimkar <[email protected]>
L: [email protected] (moderated for non-subscribers)
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
--
2.31.1

2021-09-16 09:16:34

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 19/24] MAINTAINERS: update intel,ixp46x-rng.yaml reference

The file name: Documentation/devicetree/bindings/display/intel,ixp46x-rng.yaml
should be, instead: Documentation/devicetree/bindings/rng/intel,ixp46x-rng.yaml.

Update its cross-reference accordingly.

Fixes: cca061b04c0d ("hw_random: ixp4xx: Add DT bindings")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index bb9daad21935..da9658e24496 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9509,7 +9509,7 @@ F: include/linux/soc/ixp4xx/qmgr.h
INTEL IXP4XX RANDOM NUMBER GENERATOR SUPPORT
M: Deepak Saxena <[email protected]>
S: Maintained
-F: Documentation/devicetree/bindings/display/intel,ixp46x-rng.yaml
+F: Documentation/devicetree/bindings/rng/intel,ixp46x-rng.yaml
F: drivers/char/hw_random/ixp4xx-rng.c

INTEL KEEM BAY DRM DRIVER
--
2.31.1

2021-09-16 09:16:41

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 21/24] MAINTAINERS: update gemini.yaml reference

Changeset 7da6ebf5f5a5 ("dt-bindings: arm: Convert Gemini boards to YAML")
renamed: Documentation/devicetree/bindings/arm/gemini.txt
to: Documentation/devicetree/bindings/arm/gemini.yaml.

Update its cross-reference accordingly.

Fixes: 7da6ebf5f5a5 ("dt-bindings: arm: Convert Gemini boards to YAML")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 9f1d2b8a769e..de18144b8c52 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1872,7 +1872,7 @@ M: Linus Walleij <[email protected]>
L: [email protected] (moderated for non-subscribers)
S: Maintained
T: git git://github.com/ulli-kroll/linux.git
-F: Documentation/devicetree/bindings/arm/gemini.txt
+F: Documentation/devicetree/bindings/arm/gemini.yaml
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.yaml
--
2.31.1

2021-09-16 09:16:47

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 15/24] MAINTAINERS: update fsl,fec.yaml reference

Changeset 96e4781b3d93 ("dt-bindings: net: fec: convert fsl,*fec bindings to yaml")
renamed: Documentation/devicetree/bindings/net/fsl-fec.txt
to: Documentation/devicetree/bindings/net/fsl,fec.yaml.

Update its cross-reference accordingly.

Fixes: 96e4781b3d93 ("dt-bindings: net: fec: convert fsl,*fec bindings to yaml")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index dce6cafeedab..0ba88743af92 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -7451,7 +7451,7 @@ FREESCALE IMX / MXC FEC DRIVER
M: Joakim Zhang <[email protected]>
L: [email protected]
S: Maintained
-F: Documentation/devicetree/bindings/net/fsl-fec.txt
+F: Documentation/devicetree/bindings/net/fsl,fec.yaml
F: drivers/net/ethernet/freescale/fec.h
F: drivers/net/ethernet/freescale/fec_main.c
F: drivers/net/ethernet/freescale/fec_ptp.c
--
2.31.1

2021-09-16 09:16:47

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 20/24] MAINTAINERS: update nxp,imx8-jpeg.yaml reference

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")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index da9658e24496..9f1d2b8a769e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -13545,7 +13545,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
--
2.31.1

2021-09-16 09:16:49

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 17/24] MAINTAINERS: update ti,am654-hbmc.yaml reference

Changeset 6947ad674944 ("dt-bindings: mtd: Convert ti, am654-hbmc.txt to YAML schema")
renamed: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt
to: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.yaml.

Update its cross-reference accordingly.

Fixes: 6947ad674944 ("dt-bindings: mtd: Convert ti, am654-hbmc.txt to YAML schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 0bb56ac849fc..5154c8578ea4 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8725,7 +8725,7 @@ Q: http://patchwork.ozlabs.org/project/linux-mtd/list/
C: irc://irc.oftc.net/mtd
T: git git://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git cfi/next
F: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml
-F: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt
+F: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.yaml
F: drivers/mtd/hyperbus/
F: include/linux/mtd/hyperbus.h

--
2.31.1

2021-09-16 09:16:51

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 23/24] MAINTAINERS: update chipone,icn8318.yaml reference

Changeset 04647773d648 ("dt-bindings: input: Convert ChipOne ICN8318 binding to a schema")
renamed: Documentation/devicetree/bindings/input/touchscreen/chipone_icn8318.txt
to: Documentation/devicetree/bindings/input/touchscreen/chipone,icn8318.yaml.

Update its cross-reference accordingly.

Fixes: 04647773d648 ("dt-bindings: input: Convert ChipOne ICN8318 binding to a schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index adce2bdedb9e..4bfa4d72589e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4397,7 +4397,7 @@ CHIPONE ICN8318 I2C TOUCHSCREEN DRIVER
M: Hans de Goede <[email protected]>
L: [email protected]
S: Maintained
-F: Documentation/devicetree/bindings/input/touchscreen/chipone_icn8318.txt
+F: Documentation/devicetree/bindings/input/touchscreen/chipone,icn8318.yaml
F: drivers/input/touchscreen/chipone_icn8318.c

CHIPONE ICN8505 I2C TOUCHSCREEN DRIVER
--
2.31.1

2021-09-16 09:16:53

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 14/24] MAINTAINERS: update faraday,ftrtc010.yaml reference

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")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index d0f4fe1481da..dce6cafeedab 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1875,7 +1875,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/boot/dts/gemini*
F: arch/arm/mach-gemini/
F: drivers/crypto/gemini/
--
2.31.1

2021-09-16 09:17:01

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 03/24] dt-bindings: arm: mediatek: mmsys: update mediatek,mmsys.yaml reference

Changeset cba3c40d1f97 ("dt-bindings: arm: mediatek: mmsys: convert to YAML format")
renamed: Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.txt
to: Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.yaml.

Update its cross-reference accordingly.

Fixes: cba3c40d1f97 ("dt-bindings: arm: mediatek: mmsys: convert to YAML format")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
.../devicetree/bindings/display/mediatek/mediatek,disp.txt | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/display/mediatek/mediatek,disp.txt b/Documentation/devicetree/bindings/display/mediatek/mediatek,disp.txt
index fbb59c9ddda6..78044c340e20 100644
--- a/Documentation/devicetree/bindings/display/mediatek/mediatek,disp.txt
+++ b/Documentation/devicetree/bindings/display/mediatek/mediatek,disp.txt
@@ -9,7 +9,7 @@ function block.

All DISP device tree nodes must be siblings to the central MMSYS_CONFIG node.
For a description of the MMSYS_CONFIG binding, see
-Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.txt.
+Documentation/devicetree/bindings/arm/mediatek/mediatek,mmsys.yaml.

DISP function blocks
====================
--
2.31.1

2021-09-16 09:17:01

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

The file name: Documentation/bpftool-prog.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.

Update its cross-reference accordingly.

Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
index be54b7335a76..27a2c369a798 100755
--- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
+++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
@@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
"""
An extractor for bpftool-prog.rst.
"""
- filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
+ filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')

def get_attach_types(self):
return self.get_rst_list('ATTACH_TYPE')
--
2.31.1

2021-09-16 09:17:09

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 24/24] MAINTAINERS: update silergy,sy8106a.yaml reference

Changeset b1c36aae51c9 ("regulator: Convert SY8106A binding to a schema")
renamed: Documentation/devicetree/bindings/regulator/sy8106a-regulator.txt
to: Documentation/devicetree/bindings/regulator/silergy,sy8106a.yaml.

Update its cross-reference accordingly.

Fixes: b1c36aae51c9 ("regulator: Convert SY8106A binding to a schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 4bfa4d72589e..8fed382b1935 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -18021,7 +18021,7 @@ F: net/switchdev/
SY8106A REGULATOR DRIVER
M: Icenowy Zheng <[email protected]>
S: Maintained
-F: Documentation/devicetree/bindings/regulator/sy8106a-regulator.txt
+F: Documentation/devicetree/bindings/regulator/silergy,sy8106a.yaml
F: drivers/regulator/sy8106a-regulator.c

SYNC FILE FRAMEWORK
--
2.31.1

2021-09-16 09:17:10

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 12/24] MAINTAINERS: update arm,vic.yaml reference

Changeset b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
renamed: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
to: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml.

Update its cross-reference accordingly.

Fixes: b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 0ea4cd772a0c..f02d1c94a219 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1550,7 +1550,7 @@ ARM PRIMECELL VIC PL190/PL192 DRIVER
M: Linus Walleij <[email protected]>
L: [email protected] (moderated for non-subscribers)
S: Maintained
-F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
+F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml
F: drivers/irqchip/irq-vic.c

ARM SMC WATCHDOG DRIVER
--
2.31.1

2021-09-16 09:17:10

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 11/24] MAINTAINERS: update mtd-physmap.yaml reference

Changeset 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")
renamed: Documentation/devicetree/bindings/mtd/arm-versatile.txt
to: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml.

Update its cross-reference accordingly.

Fixes: 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 30f75af400f3..0ea4cd772a0c 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1411,7 +1411,7 @@ F: Documentation/devicetree/bindings/auxdisplay/arm,versatile-lcd.yaml
F: Documentation/devicetree/bindings/clock/arm,syscon-icst.yaml
F: Documentation/devicetree/bindings/i2c/i2c-versatile.txt
F: Documentation/devicetree/bindings/interrupt-controller/arm,versatile-fpga-irq.txt
-F: Documentation/devicetree/bindings/mtd/arm-versatile.txt
+F: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml
F: arch/arm/boot/dts/arm-realview-*
F: arch/arm/boot/dts/integrator*
F: arch/arm/boot/dts/versatile*
--
2.31.1

2021-09-16 09:17:28

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 09/24] tools: bpftool: update bpftool-map.rst reference

The file name: Documentation/bpftool-map.rst
should be, instead: tools/bpf/bpftool/Documentation/bpftool-map.rst.

Update its cross-reference accordingly.

Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
index 27a2c369a798..2d7eb683bd5a 100755
--- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
+++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
@@ -383,7 +383,7 @@ class ManMapExtractor(ManPageExtractor):
"""
An extractor for bpftool-map.rst.
"""
- filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-map.rst')
+ filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-map.rst')

def get_map_types(self):
return self.get_rst_list('TYPE')
--
2.31.1

2021-09-16 09:17:33

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 04/24] dt-bindings: w1: update w1-gpio.yaml reference

Changeset dd2c898bc20b ("dt-bindings: w1: Convert 1-Wire GPIO binding to a schema")
renamed: Documentation/devicetree/bindings/w1/w1-gpio.txt
to: Documentation/devicetree/bindings/w1/w1-gpio.yaml.

Update its cross-reference accordingly.

Fixes: dd2c898bc20b ("dt-bindings: w1: Convert 1-Wire GPIO binding to a schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/w1/masters/w1-gpio.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/w1/masters/w1-gpio.rst b/Documentation/w1/masters/w1-gpio.rst
index 18fdb7366372..15236605503b 100644
--- a/Documentation/w1/masters/w1-gpio.rst
+++ b/Documentation/w1/masters/w1-gpio.rst
@@ -11,7 +11,7 @@ Description
GPIO 1-wire bus master driver. The driver uses the GPIO API to control the
wire and the GPIO pin can be specified using GPIO machine descriptor tables.
It is also possible to define the master using device tree, see
-Documentation/devicetree/bindings/w1/w1-gpio.txt
+Documentation/devicetree/bindings/w1/w1-gpio.yaml


Example (mach-at91)
--
2.31.1

2021-09-16 09:17:58

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 07/24] docs: accounting: update delay-accounting.rst reference

The file name: accounting/delay-accounting.rst
should be, instead: Documentation/accounting/delay-accounting.rst.

Update its cross-reference accordingly.

Fixes: fcb501704554 ("delayacct: Document task_delayacct sysctl")
Fixes: c3123552aad3 ("docs: accounting: convert to ReST")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
Documentation/admin-guide/sysctl/kernel.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index 426162009ce9..2b03422ef5f7 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -1099,7 +1099,7 @@ task_delayacct
===============

Enables/disables task delay accounting (see
-:doc:`accounting/delay-accounting.rst`). Enabling this feature incurs
+:doc:`Documentation/accounting/delay-accounting.rst`). 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.

--
2.31.1

2021-09-16 09:18:05

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH 16/24] MAINTAINERS: update mtd-physmap.yaml reference

Changeset 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")
renamed: Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt
to: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml.

Update its cross-reference accordingly.

Fixes: 63f8e9e0ac65 ("dt-bindings: mtd: Convert mtd-physmap to DT schema")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
MAINTAINERS | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 0ba88743af92..0bb56ac849fc 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -8724,7 +8724,7 @@ S: Supported
Q: http://patchwork.ozlabs.org/project/linux-mtd/list/
C: irc://irc.oftc.net/mtd
T: git git://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git cfi/next
-F: Documentation/devicetree/bindings/mtd/cypress,hyperflash.txt
+F: Documentation/devicetree/bindings/mtd/mtd-physmap.yaml
F: Documentation/devicetree/bindings/mtd/ti,am654-hbmc.txt
F: drivers/mtd/hyperbus/
F: include/linux/mtd/hyperbus.h
--
2.31.1

2021-09-16 09:18:41

by Joakim Zhang

[permalink] [raw]
Subject: RE: [PATCH 15/24] MAINTAINERS: update fsl,fec.yaml reference


> -----Original Message-----
> From: Mauro Carvalho Chehab <[email protected]> On Behalf Of Mauro
> Carvalho Chehab
> Sent: 2021??9??16?? 17:14
> To: Linux Doc Mailing List <[email protected]>; Jonathan Corbet
> <[email protected]>
> Cc: Mauro Carvalho Chehab <[email protected]>; David S. Miller
> <[email protected]>; Joakim Zhang <[email protected]>;
> [email protected]
> Subject: [PATCH 15/24] MAINTAINERS: update fsl,fec.yaml reference
>
> Changeset 96e4781b3d93 ("dt-bindings: net: fec: convert fsl,*fec bindings to
> yaml")
> renamed: Documentation/devicetree/bindings/net/fsl-fec.txt
> to: Documentation/devicetree/bindings/net/fsl,fec.yaml.
>
> Update its cross-reference accordingly.
>
> Fixes: 96e4781b3d93 ("dt-bindings: net: fec: convert fsl,*fec bindings to yaml")
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---

Thanks Mauro Carvalho Chehab,

Reviewed-by: Joakim Zhang <[email protected]>

Best Regards,
Joakim Zhang

> MAINTAINERS | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index dce6cafeedab..0ba88743af92 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -7451,7 +7451,7 @@ FREESCALE IMX / MXC FEC DRIVER
> M: Joakim Zhang <[email protected]>
> L: [email protected]
> S: Maintained
> -F: Documentation/devicetree/bindings/net/fsl-fec.txt
> +F: Documentation/devicetree/bindings/net/fsl,fec.yaml
> F: drivers/net/ethernet/freescale/fec.h
> F: drivers/net/ethernet/freescale/fec_main.c
> F: drivers/net/ethernet/freescale/fec_ptp.c
> --
> 2.31.1

2021-09-16 09:20:04

by Sudeep Holla

[permalink] [raw]
Subject: Re: [PATCH 12/24] MAINTAINERS: update arm,vic.yaml reference

On Thu, Sep 16, 2021 at 11:14:05AM +0200, Mauro Carvalho Chehab wrote:
> Changeset b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
> renamed: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
> to: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml.
>
> Update its cross-reference accordingly.
>
> Fixes: b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> MAINTAINERS | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 0ea4cd772a0c..f02d1c94a219 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1550,7 +1550,7 @@ ARM PRIMECELL VIC PL190/PL192 DRIVER
> M: Linus Walleij <[email protected]>
> L: [email protected] (moderated for non-subscribers)
> S: Maintained
> -F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
> +F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml
> F: drivers/irqchip/irq-vic.c

You seem to have dropped the tags already provided here [1]

--
Regards,
Sudeep

[1] https://lore.kernel.org/all/7dbff9673e8703cd60e78f8b2110349d86d60a87.1626947923.git.mchehab+huawei@kernel.org

2021-09-16 09:45:58

by Quentin Monnet

[permalink] [raw]
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
<[email protected]>
> The file name: Documentation/bpftool-prog.rst
> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.
>
> Update its cross-reference accordingly.
>
> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")

Hi,
How is this a fix for the commit that added the documentation in bpftool?

> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
> tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> index be54b7335a76..27a2c369a798 100755
> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
> """
> An extractor for bpftool-prog.rst.
> """
> - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
> + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')
>
> def get_attach_types(self):
> return self.get_rst_list('ATTACH_TYPE')
>

No I don't believe it should. BPFTOOL_DIR already contains
'tools/bpf/bpftool' and the os.path.join() concatenates the two path
fragments.

Where is this suggestion coming from? Did you face an issue with the script?

Same comment applies for the next two patches.

Quentin

2021-09-16 09:51:54

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH 12/24] MAINTAINERS: update arm,vic.yaml reference

Em Thu, 16 Sep 2021 10:18:36 +0100
Sudeep Holla <[email protected]> escreveu:

> On Thu, Sep 16, 2021 at 11:14:05AM +0200, Mauro Carvalho Chehab wrote:
> > Changeset b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
> > renamed: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
> > to: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml.
> >
> > Update its cross-reference accordingly.
> >
> > Fixes: b7705ba6d0c4 ("dt-bindings: interrupt-controller: Convert ARM VIC to json-schema")
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> > ---
> > MAINTAINERS | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index 0ea4cd772a0c..f02d1c94a219 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -1550,7 +1550,7 @@ ARM PRIMECELL VIC PL190/PL192 DRIVER
> > M: Linus Walleij <[email protected]>
> > L: [email protected] (moderated for non-subscribers)
> > S: Maintained
> > -F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.txt
> > +F: Documentation/devicetree/bindings/interrupt-controller/arm,vic.yaml
> > F: drivers/irqchip/irq-vic.c
>
> You seem to have dropped the tags already provided here [1]

Gah, true :-(

I forgot I submitted part of those patches already. Will send a v2
with the missing reviewed-by/acked-by.

Thanks,
Mauro

2021-09-16 10:15:57

by Rafał Miłecki

[permalink] [raw]
Subject: Re: [PATCH 22/24] MAINTAINERS: update brcm,unimac-mdio.yaml reference

On 2021-09-16 11:14, Mauro Carvalho Chehab wrote:
> Changeset 5d1c5594b646 ("dt-bindings: net: brcm,unimac-mdio: convert
> to the json-schema")
> renamed: Documentation/devicetree/bindings/net/brcm,unimac-mdio.txt
> to: Documentation/devicetree/bindings/net/brcm,unimac-mdio.yaml.
>
> Update its cross-reference accordingly.

Quick question: do we want to reference .yaml files in the MAINTAINERS
at all?

Every YAML has maintainer specified on its own and new YAML files often
come without a MAINTAINERS entry.

2021-09-16 10:50:38

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

Hi Quentin,

Em Thu, 16 Sep 2021 10:43:45 +0100
Quentin Monnet <[email protected]> escreveu:

> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
> <[email protected]>
> > The file name: Documentation/bpftool-prog.rst
> > should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.
> >
> > Update its cross-reference accordingly.
> >
> > Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> > Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")
>
> Hi,
> How is this a fix for the commit that added the documentation in bpftool?
>
> > Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> > ---
> > tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > index be54b7335a76..27a2c369a798 100755
> > --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> > @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
> > """
> > An extractor for bpftool-prog.rst.
> > """
> > - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
> > + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')
> >
> > def get_attach_types(self):
> > return self.get_rst_list('ATTACH_TYPE')
> >
>
> No I don't believe it should. BPFTOOL_DIR already contains
> 'tools/bpf/bpftool' and the os.path.join() concatenates the two path
> fragments.
>
> Where is this suggestion coming from? Did you face an issue with the script?

No, I didn't face any issues with this script.

The suggestion cames from the script at:

./scripts/documentation-file-ref-check

which is meant to discover broken doc references.

Such script has already a rule to handle stuff under tools/:

# Accept relative Documentation patches for tools/
if ($f =~ m/tools/) {
my $path = $f;
$path =~ s,(.*)/.*,$1,;
next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
}

but it seems it needs a fixup in order for it to stop reporting issues
at test_bpftool_synctypes.py:

$ ./scripts/documentation-file-ref-check
...
tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-prog.rst
tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-map.rst
tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-cgroup.rst

I'll drop the patches touching it for a next version, probably
adding a fix for such script.

Thanks,
Mauro

2021-09-16 10:58:51

by Quentin Monnet

[permalink] [raw]
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

2021-09-16 12:49 UTC+0200 ~ Mauro Carvalho Chehab
<[email protected]>
> Hi Quentin,
>
> Em Thu, 16 Sep 2021 10:43:45 +0100
> Quentin Monnet <[email protected]> escreveu:
>
>> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
>> <[email protected]>
>>> The file name: Documentation/bpftool-prog.rst
>>> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.
>>>
>>> Update its cross-reference accordingly.
>>>
>>> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
>>> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")
>>
>> Hi,
>> How is this a fix for the commit that added the documentation in bpftool?
>>
>>> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>>> ---
>>> tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
>>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
>>> index be54b7335a76..27a2c369a798 100755
>>> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
>>> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
>>> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
>>> """
>>> An extractor for bpftool-prog.rst.
>>> """
>>> - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
>>> + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')
>>>
>>> def get_attach_types(self):
>>> return self.get_rst_list('ATTACH_TYPE')
>>>
>>
>> No I don't believe it should. BPFTOOL_DIR already contains
>> 'tools/bpf/bpftool' and the os.path.join() concatenates the two path
>> fragments.
>>
>> Where is this suggestion coming from? Did you face an issue with the script?
>
> No, I didn't face any issues with this script.
>
> The suggestion cames from the script at:
>
> ./scripts/documentation-file-ref-check
>
> which is meant to discover broken doc references.
>
> Such script has already a rule to handle stuff under tools/:
>
> # Accept relative Documentation patches for tools/
> if ($f =~ m/tools/) {
> my $path = $f;
> $path =~ s,(.*)/.*,$1,;
> next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
> }
>
> but it seems it needs a fixup in order for it to stop reporting issues
> at test_bpftool_synctypes.py:
>
> $ ./scripts/documentation-file-ref-check
> ...
> tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-prog.rst
> tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-map.rst
> tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-cgroup.rst

Oh, I see, thanks for explaining. I didn't know this script would catch
the paths in bpftool's test file.

>
> I'll drop the patches touching it for a next version, probably
> adding a fix for such script.
>
> Thanks,
> Mauro
>

Sounds good to me, thanks a lot!
Quentin

2021-09-16 11:25:15

by Mark Brown

[permalink] [raw]
Subject: Re: [PATCH 24/24] MAINTAINERS: update silergy,sy8106a.yaml reference

On Thu, Sep 16, 2021 at 11:14:17AM +0200, Mauro Carvalho Chehab wrote:
> Changeset b1c36aae51c9 ("regulator: Convert SY8106A binding to a schema")
> renamed: Documentation/devicetree/bindings/regulator/sy8106a-regulator.txt
> to: Documentation/devicetree/bindings/regulator/silergy,sy8106a.yaml.

What's the story with dependencies here? You've just sent a single
patch with no cover letter or anything. I can't see any reason why
there would be any?


Attachments:
(No filename) (461.00 B)
signature.asc (499.00 B)
Download all attachments

2021-09-16 11:32:30

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

Em Thu, 16 Sep 2021 11:57:51 +0100
Quentin Monnet <[email protected]> escreveu:

> 2021-09-16 12:49 UTC+0200 ~ Mauro Carvalho Chehab
> <[email protected]>
> > Hi Quentin,
> >
> > Em Thu, 16 Sep 2021 10:43:45 +0100
> > Quentin Monnet <[email protected]> escreveu:
> >
> >> 2021-09-16 11:14 UTC+0200 ~ Mauro Carvalho Chehab
> >> <[email protected]>
> >>> The file name: Documentation/bpftool-prog.rst
> >>> should be, instead: tools/bpf/bpftool/Documentation/bpftool-prog.rst.
> >>>
> >>> Update its cross-reference accordingly.
> >>>
> >>> Fixes: a2b5944fb4e0 ("selftests/bpf: Check consistency between bpftool source, doc, completion")
> >>> Fixes: ff69c21a85a4 ("tools: bpftool: add documentation")
> >>
> >> Hi,
> >> How is this a fix for the commit that added the documentation in bpftool?
> >>
> >>> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> >>> ---
> >>> tools/testing/selftests/bpf/test_bpftool_synctypes.py | 2 +-
> >>> 1 file changed, 1 insertion(+), 1 deletion(-)
> >>>
> >>> diff --git a/tools/testing/selftests/bpf/test_bpftool_synctypes.py b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> >>> index be54b7335a76..27a2c369a798 100755
> >>> --- a/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> >>> +++ b/tools/testing/selftests/bpf/test_bpftool_synctypes.py
> >>> @@ -374,7 +374,7 @@ class ManProgExtractor(ManPageExtractor):
> >>> """
> >>> An extractor for bpftool-prog.rst.
> >>> """
> >>> - filename = os.path.join(BPFTOOL_DIR, 'Documentation/bpftool-prog.rst')
> >>> + filename = os.path.join(BPFTOOL_DIR, 'tools/bpf/bpftool/Documentation/bpftool-prog.rst')
> >>>
> >>> def get_attach_types(self):
> >>> return self.get_rst_list('ATTACH_TYPE')
> >>>
> >>
> >> No I don't believe it should. BPFTOOL_DIR already contains
> >> 'tools/bpf/bpftool' and the os.path.join() concatenates the two path
> >> fragments.
> >>
> >> Where is this suggestion coming from? Did you face an issue with the script?
> >
> > No, I didn't face any issues with this script.
> >
> > The suggestion cames from the script at:
> >
> > ./scripts/documentation-file-ref-check
> >
> > which is meant to discover broken doc references.
> >
> > Such script has already a rule to handle stuff under tools/:
> >
> > # Accept relative Documentation patches for tools/
> > if ($f =~ m/tools/) {
> > my $path = $f;
> > $path =~ s,(.*)/.*,$1,;
> > next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
> > }
> >
> > but it seems it needs a fixup in order for it to stop reporting issues
> > at test_bpftool_synctypes.py:
> >
> > $ ./scripts/documentation-file-ref-check
> > ...
> > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-prog.rst
> > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-map.rst
> > tools/testing/selftests/bpf/test_bpftool_synctypes.py: Documentation/bpftool-cgroup.rst
>
> Oh, I see, thanks for explaining. I didn't know this script would catch
> the paths in bpftool's test file.
>
> >
> > I'll drop the patches touching it for a next version, probably
> > adding a fix for such script.
> >
> > Thanks,
> > Mauro
> >
>
> Sounds good to me, thanks a lot!

The enclosed patch should do the trick.

> Quentin

Thanks,
Mauro

[PATCH] scripts: documentation-file-ref-check: fix bpf selftests path

tools/testing/selftests/bpf/test_bpftool_synctypes.py use
relative patches on the top of BPFTOOL_DIR:

BPFTOOL_DIR = os.path.join(LINUX_ROOT, 'tools/bpf/bpftool')

Change the script to automatically convert:

testing/selftests/bpf -> bpf/bpftool

In order to properly check the files used by such script.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index 7187ea5e5149..2d91cfe11cd2 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -144,6 +144,7 @@ while (<IN>) {
if ($f =~ m/tools/) {
my $path = $f;
$path =~ s,(.*)/.*,$1,;
+ $path =~ s,testing/selftests/bpf,bpf/bpftool,;
next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
}




2021-09-16 12:14:00

by Quentin Monnet

[permalink] [raw]
Subject: Re: [PATCH 08/24] tools: bpftool: update bpftool-prog.rst reference

2021-09-16 13:30 UTC+0200 ~ Mauro Carvalho Chehab
<[email protected]>

> [PATCH] scripts: documentation-file-ref-check: fix bpf selftests path
>
> tools/testing/selftests/bpf/test_bpftool_synctypes.py use
> relative patches on the top of BPFTOOL_DIR:
>
> BPFTOOL_DIR = os.path.join(LINUX_ROOT, 'tools/bpf/bpftool')
>
> Change the script to automatically convert:
>
> testing/selftests/bpf -> bpf/bpftool
>
> In order to properly check the files used by such script.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
>
> diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
> index 7187ea5e5149..2d91cfe11cd2 100755
> --- a/scripts/documentation-file-ref-check
> +++ b/scripts/documentation-file-ref-check
> @@ -144,6 +144,7 @@ while (<IN>) {
> if ($f =~ m/tools/) {
> my $path = $f;
> $path =~ s,(.*)/.*,$1,;
> + $path =~ s,testing/selftests/bpf,bpf/bpftool,;
> next if (grep -e, glob("$path/$ref $path/../$ref $path/$fulref"));
> }
>
>
>
>

I tested the patch and it works well on my side.

However, this looks a bit fragile to me. There is no particular reason
to have testing/selftests/bpf point to bpf/bpftool other than to
accommodate the current case, we could imagine other selftest files
pointing to other parts of the documentation in the future. I would
instead make an exception for test_bpftool_synctypes.py specifically
(other selftest files don't usually parse documentation anyway).
Alternatively, I would look at excluding lines where the path is used in
code (tricky to detect), maybe at least when used with os.path.join():

next if ($ln =~ m,os\.path\.join\([^\,]*\,\s*['"]$fulref,);

But I'm not familiar with documentation-file-ref-check in the first
place, so these are just my two cents.

Thanks,
Quentin