| Message ID | 20200225180011.8129-1-patrick.delaunay@st.com |
|---|---|
| State | New |
| Headers | show |
| Series | doc: Makefile: remove target refcheckdocs | expand |
On 2/25/20 7:00 PM, Patrick Delaunay wrote: > Remove the target refcheckdocs, based on the missing script > scripts/documentation-file-ref-check. > > This script exists in Linux tree but wasn't imported when 'doc' move > to SPHINX in commit 78a88f7930be ("doc: Replace DocBook with > sphinx-based docs") > > This patch avoids the error: > > make refcheckdocs > /bin/sh: scripts/documentation-file-ref-check: No such file or directory > doc/Makefile:102: recipe for target 'refcheckdocs' failed > make[1]: *** [refcheckdocs] Error 127 > Makefile:2094: recipe for target 'refcheckdocs' failed > make: *** [refcheckdocs] Error 2 > > Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com> When we copy and adjust the missing script we can identify dozens of documentation errors, see below. So I think we should fix the make target instead of removing it. arch/arm/mach-imx/Kconfig: doc/README.mxc_hab arch/arm/mach-imx/Kconfig: doc/README.mxc_hab board/advantech/dms-ba16/dms-ba16_1g.cfg: doc/README.imximage board/advantech/dms-ba16/dms-ba16_2g.cfg: doc/README.imximage board/aristainetos/aristainetos2.cfg: doc/README.imximage board/bachmann/ot1200/mx6q_4x_mt41j128.cfg: doc/README.imximage board/barco/titanium/imximage.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6dl.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6dl2g.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6q.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6q2g.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6s.cfg: doc/README.imximage board/boundary/nitrogen6x/nitrogen6s1g.cfg: doc/README.imximage board/ccv/xpress/imximage.cfg: doc/README.imximage board/cobra5272/README: u-boot-x-x-x/doc/README.COBRA5272 board/freescale/imx8qxp_mek/imximage.cfg: doc/README.imx8image board/freescale/m52277evb/README: doc/README.m52277evb board/freescale/m53017evb/README: doc/README.m53017evb board/freescale/m5373evb/README: doc/README.m5373evb board/freescale/m54455evb/README: doc/README.m54455evb board/freescale/m547xevb/README: doc/README.m5475evb board/freescale/mx25pdk/imximage.cfg: doc/README.imximage board/freescale/mx51evk/imximage.cfg: doc/README.imximage board/freescale/mx53ard/imximage_dd3.cfg: doc/README.imximage board/freescale/mx53evk/imximage.cfg: doc/README.imximage board/freescale/mx53loco/imximage.cfg: doc/README.imximage board/freescale/mx53smd/imximage.cfg: doc/README.imximage board/freescale/mx6qarm2/imximage.cfg: doc/README.imximage board/freescale/mx6qarm2/imximage_mx6dl.cfg: doc/README.imximage board/freescale/mx6slevk/imximage.cfg: doc/README.imximage board/freescale/mx6ullevk/imximage.cfg: doc/README.imximage board/freescale/mx7dsabresd/imximage.cfg: doc/README.imximage board/freescale/s32v234evb/s32v234evb.cfg: doc/README.imximage board/freescale/vf610twr/imximage.cfg: doc/README.imximage board/ge/bx50v3/bx50v3.cfg: doc/README.imximage board/ge/mx53ppd/imximage.cfg: doc/README.imximage board/menlo/m53menlo/imximage.cfg: doc/README.imximage board/phytec/pcm052/imximage.cfg: doc/README.imximage board/seco/mx6quq7/mx6quq7-2g.cfg: doc/README.imximage board/siemens/capricorn/imximage.cfg: doc/README.imx8image board/technexion/pico-imx6ul/imximage.cfg: doc/README.imximage board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg: doc/README.imx8image board/toradex/colibri-imx6ull/imximage.cfg: doc/README.imximage board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg: doc/README.imx8image board/toradex/colibri_imx7/imximage.cfg: doc/README.imximage board/toradex/colibri_vf/imximage.cfg: doc/README.imximage board/tqc/tqma6/clocks.cfg: doc/README.imximage board/tqc/tqma6/tqma6dl.cfg: doc/README.imximage board/tqc/tqma6/tqma6q.cfg: doc/README.imximage board/tqc/tqma6/tqma6s.cfg: doc/README.imximage board/warp/imximage.cfg: doc/README.imximage board/warp7/imximage.cfg: doc/README.imximage cmd/Kconfig: doc/README.beddbug doc/README.drivers.eth: doc/driver-model/README.txt doc/README.fdt-control: doc/driver-model/README.txt doc/device-tree-bindings/net/ti,dp83867.txt: doc/devicetree/bindings/net/ethernet.txt doc/device-tree-bindings/video/rockchip-lvds.txt: doc/devicetree/device-tree-bindings/video/display-timing.txt doc/imx/misc/sdp.txt: doc/README.imximage doc/sphinx/parse-headers.pl: doc/doc-guide/parse-headers.rst doc/sphinx/rstFlatTable.py: doc/books/kernel-doc-HOWTO drivers/i2c/davinci_i2c.c: doc/driver-model/i2c-howto.txt drivers/i2c/kona_i2c.c: doc/driver-model/i2c-howto.txt drivers/i2c/sh_i2c.c: doc/driver-model/i2c-howto.txt drivers/i2c/soft_i2c.c: doc/driver-model/i2c-howto.txt drivers/rtc/ds1374.c: Watchdoc/Alarm include/ata.h: ftp://ftp.fee.vutbr.cz/pub/doc/io/ata/ata-3/ata3r5v.zip include/configs/sbc8548.h: doc/README.sbc8548 include/fsl_qe.h: doc/README.qe_firmware lib/zlib/trees.c: ftp.uu.net:/pub/archiving/zip/doc/deflate-1.1.doc tools/dtoc/dtb_platdata.py: doc/driver-model/of-plat.txt tools/dtoc/dtoc.py: doc/driver-model/of-plat.txt Best regards Heinrich
On Tue, Feb 25, 2020 at 07:10:01PM +0100, Heinrich Schuchardt wrote: > On 2/25/20 7:00 PM, Patrick Delaunay wrote: > > Remove the target refcheckdocs, based on the missing script > > scripts/documentation-file-ref-check. > > > > This script exists in Linux tree but wasn't imported when 'doc' move > > to SPHINX in commit 78a88f7930be ("doc: Replace DocBook with > > sphinx-based docs") > > > > This patch avoids the error: > > > > make refcheckdocs > > /bin/sh: scripts/documentation-file-ref-check: No such file or directory > > doc/Makefile:102: recipe for target 'refcheckdocs' failed > > make[1]: *** [refcheckdocs] Error 127 > > Makefile:2094: recipe for target 'refcheckdocs' failed > > make: *** [refcheckdocs] Error 2 > > > > Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com> > > When we copy and adjust the missing script we can identify dozens of > documentation errors, see below. So I think we should fix the make > target instead of removing it. > > arch/arm/mach-imx/Kconfig: doc/README.mxc_hab > arch/arm/mach-imx/Kconfig: doc/README.mxc_hab > board/advantech/dms-ba16/dms-ba16_1g.cfg: doc/README.imximage > board/advantech/dms-ba16/dms-ba16_2g.cfg: doc/README.imximage > board/aristainetos/aristainetos2.cfg: doc/README.imximage > board/bachmann/ot1200/mx6q_4x_mt41j128.cfg: doc/README.imximage > board/barco/titanium/imximage.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6dl.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6dl2g.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6q.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6q2g.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6s.cfg: doc/README.imximage > board/boundary/nitrogen6x/nitrogen6s1g.cfg: doc/README.imximage > board/ccv/xpress/imximage.cfg: doc/README.imximage > board/cobra5272/README: u-boot-x-x-x/doc/README.COBRA5272 > board/freescale/imx8qxp_mek/imximage.cfg: doc/README.imx8image > board/freescale/m52277evb/README: doc/README.m52277evb > board/freescale/m53017evb/README: doc/README.m53017evb > board/freescale/m5373evb/README: doc/README.m5373evb > board/freescale/m54455evb/README: doc/README.m54455evb > board/freescale/m547xevb/README: doc/README.m5475evb > board/freescale/mx25pdk/imximage.cfg: doc/README.imximage > board/freescale/mx51evk/imximage.cfg: doc/README.imximage > board/freescale/mx53ard/imximage_dd3.cfg: doc/README.imximage > board/freescale/mx53evk/imximage.cfg: doc/README.imximage > board/freescale/mx53loco/imximage.cfg: doc/README.imximage > board/freescale/mx53smd/imximage.cfg: doc/README.imximage > board/freescale/mx6qarm2/imximage.cfg: doc/README.imximage > board/freescale/mx6qarm2/imximage_mx6dl.cfg: doc/README.imximage > board/freescale/mx6slevk/imximage.cfg: doc/README.imximage > board/freescale/mx6ullevk/imximage.cfg: doc/README.imximage > board/freescale/mx7dsabresd/imximage.cfg: doc/README.imximage > board/freescale/s32v234evb/s32v234evb.cfg: doc/README.imximage > board/freescale/vf610twr/imximage.cfg: doc/README.imximage > board/ge/bx50v3/bx50v3.cfg: doc/README.imximage > board/ge/mx53ppd/imximage.cfg: doc/README.imximage > board/menlo/m53menlo/imximage.cfg: doc/README.imximage > board/phytec/pcm052/imximage.cfg: doc/README.imximage > board/seco/mx6quq7/mx6quq7-2g.cfg: doc/README.imximage > board/siemens/capricorn/imximage.cfg: doc/README.imx8image > board/technexion/pico-imx6ul/imximage.cfg: doc/README.imximage > board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg: doc/README.imx8image > board/toradex/colibri-imx6ull/imximage.cfg: doc/README.imximage > board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg: > doc/README.imx8image > board/toradex/colibri_imx7/imximage.cfg: doc/README.imximage > board/toradex/colibri_vf/imximage.cfg: doc/README.imximage > board/tqc/tqma6/clocks.cfg: doc/README.imximage > board/tqc/tqma6/tqma6dl.cfg: doc/README.imximage > board/tqc/tqma6/tqma6q.cfg: doc/README.imximage > board/tqc/tqma6/tqma6s.cfg: doc/README.imximage > board/warp/imximage.cfg: doc/README.imximage > board/warp7/imximage.cfg: doc/README.imximage > cmd/Kconfig: doc/README.beddbug > doc/README.drivers.eth: doc/driver-model/README.txt > doc/README.fdt-control: doc/driver-model/README.txt > doc/device-tree-bindings/net/ti,dp83867.txt: > doc/devicetree/bindings/net/ethernet.txt > doc/device-tree-bindings/video/rockchip-lvds.txt: > doc/devicetree/device-tree-bindings/video/display-timing.txt > doc/imx/misc/sdp.txt: doc/README.imximage > doc/sphinx/parse-headers.pl: doc/doc-guide/parse-headers.rst > doc/sphinx/rstFlatTable.py: doc/books/kernel-doc-HOWTO > drivers/i2c/davinci_i2c.c: doc/driver-model/i2c-howto.txt > drivers/i2c/kona_i2c.c: doc/driver-model/i2c-howto.txt > drivers/i2c/sh_i2c.c: doc/driver-model/i2c-howto.txt > drivers/i2c/soft_i2c.c: doc/driver-model/i2c-howto.txt > drivers/rtc/ds1374.c: Watchdoc/Alarm > include/ata.h: ftp://ftp.fee.vutbr.cz/pub/doc/io/ata/ata-3/ata3r5v.zip > include/configs/sbc8548.h: doc/README.sbc8548 > include/fsl_qe.h: doc/README.qe_firmware > lib/zlib/trees.c: ftp.uu.net:/pub/archiving/zip/doc/deflate-1.1.doc > tools/dtoc/dtb_platdata.py: doc/driver-model/of-plat.txt > tools/dtoc/dtoc.py: doc/driver-model/of-plat.txt Agreed. And then make new errors a CI fatal? Thanks!
Hi Heinrich, > From: Tom Rini <trini at konsulko.com> > Sent: mardi 25 f?vrier 2020 19:44 > > On Tue, Feb 25, 2020 at 07:10:01PM +0100, Heinrich Schuchardt wrote: > > On 2/25/20 7:00 PM, Patrick Delaunay wrote: > > > Remove the target refcheckdocs, based on the missing script > > > scripts/documentation-file-ref-check. > > > > > > This script exists in Linux tree but wasn't imported when 'doc' move > > > to SPHINX in commit 78a88f7930be ("doc: Replace DocBook with > > > sphinx-based docs") > > > > > > This patch avoids the error: > > > > > > make refcheckdocs > > > /bin/sh: scripts/documentation-file-ref-check: No such file or > > > directory > > > doc/Makefile:102: recipe for target 'refcheckdocs' failed > > > make[1]: *** [refcheckdocs] Error 127 > > > Makefile:2094: recipe for target 'refcheckdocs' failed > > > make: *** [refcheckdocs] Error 2 > > > > > > Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com> > > > > When we copy and adjust the missing script we can identify dozens of > > documentation errors, see below. So I think we should fix the make > > target instead of removing it. > > > > arch/arm/mach-imx/Kconfig: doc/README.mxc_hab > > arch/arm/mach-imx/Kconfig: doc/README.mxc_hab > > board/advantech/dms-ba16/dms-ba16_1g.cfg: doc/README.imximage > > board/advantech/dms-ba16/dms-ba16_2g.cfg: doc/README.imximage > > board/aristainetos/aristainetos2.cfg: doc/README.imximage > > board/bachmann/ot1200/mx6q_4x_mt41j128.cfg: doc/README.imximage > > board/barco/titanium/imximage.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6dl.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6dl2g.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6q.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6q2g.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6s.cfg: doc/README.imximage > > board/boundary/nitrogen6x/nitrogen6s1g.cfg: doc/README.imximage > > board/ccv/xpress/imximage.cfg: doc/README.imximage > > board/cobra5272/README: u-boot-x-x-x/doc/README.COBRA5272 > > board/freescale/imx8qxp_mek/imximage.cfg: doc/README.imx8image > > board/freescale/m52277evb/README: doc/README.m52277evb > > board/freescale/m53017evb/README: doc/README.m53017evb > > board/freescale/m5373evb/README: doc/README.m5373evb > > board/freescale/m54455evb/README: doc/README.m54455evb > > board/freescale/m547xevb/README: doc/README.m5475evb > > board/freescale/mx25pdk/imximage.cfg: doc/README.imximage > > board/freescale/mx51evk/imximage.cfg: doc/README.imximage > > board/freescale/mx53ard/imximage_dd3.cfg: doc/README.imximage > > board/freescale/mx53evk/imximage.cfg: doc/README.imximage > > board/freescale/mx53loco/imximage.cfg: doc/README.imximage > > board/freescale/mx53smd/imximage.cfg: doc/README.imximage > > board/freescale/mx6qarm2/imximage.cfg: doc/README.imximage > > board/freescale/mx6qarm2/imximage_mx6dl.cfg: doc/README.imximage > > board/freescale/mx6slevk/imximage.cfg: doc/README.imximage > > board/freescale/mx6ullevk/imximage.cfg: doc/README.imximage > > board/freescale/mx7dsabresd/imximage.cfg: doc/README.imximage > > board/freescale/s32v234evb/s32v234evb.cfg: doc/README.imximage > > board/freescale/vf610twr/imximage.cfg: doc/README.imximage > > board/ge/bx50v3/bx50v3.cfg: doc/README.imximage > > board/ge/mx53ppd/imximage.cfg: doc/README.imximage > > board/menlo/m53menlo/imximage.cfg: doc/README.imximage > > board/phytec/pcm052/imximage.cfg: doc/README.imximage > > board/seco/mx6quq7/mx6quq7-2g.cfg: doc/README.imximage > > board/siemens/capricorn/imximage.cfg: doc/README.imx8image > > board/technexion/pico-imx6ul/imximage.cfg: doc/README.imximage > > board/toradex/apalis-imx8/apalis-imx8qm-imximage.cfg: > > doc/README.imx8image > > board/toradex/colibri-imx6ull/imximage.cfg: doc/README.imximage > > board/toradex/colibri-imx8x/colibri-imx8qxp-imximage.cfg: > > doc/README.imx8image > > board/toradex/colibri_imx7/imximage.cfg: doc/README.imximage > > board/toradex/colibri_vf/imximage.cfg: doc/README.imximage > > board/tqc/tqma6/clocks.cfg: doc/README.imximage > > board/tqc/tqma6/tqma6dl.cfg: doc/README.imximage > > board/tqc/tqma6/tqma6q.cfg: doc/README.imximage > > board/tqc/tqma6/tqma6s.cfg: doc/README.imximage > > board/warp/imximage.cfg: doc/README.imximage > > board/warp7/imximage.cfg: doc/README.imximage > > cmd/Kconfig: doc/README.beddbug > > doc/README.drivers.eth: doc/driver-model/README.txt > > doc/README.fdt-control: doc/driver-model/README.txt > > doc/device-tree-bindings/net/ti,dp83867.txt: > > doc/devicetree/bindings/net/ethernet.txt > > doc/device-tree-bindings/video/rockchip-lvds.txt: > > doc/devicetree/device-tree-bindings/video/display-timing.txt > > doc/imx/misc/sdp.txt: doc/README.imximage > > doc/sphinx/parse-headers.pl: doc/doc-guide/parse-headers.rst > > doc/sphinx/rstFlatTable.py: doc/books/kernel-doc-HOWTO > > drivers/i2c/davinci_i2c.c: doc/driver-model/i2c-howto.txt > > drivers/i2c/kona_i2c.c: doc/driver-model/i2c-howto.txt > > drivers/i2c/sh_i2c.c: doc/driver-model/i2c-howto.txt > > drivers/i2c/soft_i2c.c: doc/driver-model/i2c-howto.txt > > drivers/rtc/ds1374.c: Watchdoc/Alarm > > include/ata.h: ftp://ftp.fee.vutbr.cz/pub/doc/io/ata/ata-3/ata3r5v.zip > > include/configs/sbc8548.h: doc/README.sbc8548 > > include/fsl_qe.h: doc/README.qe_firmware > > lib/zlib/trees.c: ftp.uu.net:/pub/archiving/zip/doc/deflate-1.1.doc > > tools/dtoc/dtb_platdata.py: doc/driver-model/of-plat.txt > > tools/dtoc/dtoc.py: doc/driver-model/of-plat.txt > > Agreed. And then make new errors a CI fatal? Thanks! Agreed also. I did not have the courage to do it (in fact: I started, but I did not succeed and I give up) FYI: that can't be CI fatal today, because the current script give too many false positive For example : board/aristainetos/aristainetos2.cfg: doc/README.imximage cmd/Kconfig: doc/README.beddbug => these file exist Thanks > -- > Tom
diff --git a/doc/Makefile b/doc/Makefile index 0e0da5666f..2ef0be7c9b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -98,9 +98,6 @@ endif # HAVE_SPHINX # The following targets are independent of HAVE_SPHINX, and the rules should # work or silently pass without Sphinx. -refcheckdocs: - $(Q)cd $(srctree);scripts/documentation-file-ref-check - cleandocs: $(Q)rm -rf $(BUILDDIR) $(Q)$(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media clean @@ -113,7 +110,6 @@ dochelp: @echo ' epubdocs - EPUB' @echo ' xmldocs - XML' @echo ' linkcheckdocs - check for broken external links (will connect to external hosts)' - @echo ' refcheckdocs - check for references to non-existing files under Documentation' @echo ' cleandocs - clean all generated files' @echo @echo ' make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
Remove the target refcheckdocs, based on the missing script scripts/documentation-file-ref-check. This script exists in Linux tree but wasn't imported when 'doc' move to SPHINX in commit 78a88f7930be ("doc: Replace DocBook with sphinx-based docs") This patch avoids the error: make refcheckdocs /bin/sh: scripts/documentation-file-ref-check: No such file or directory doc/Makefile:102: recipe for target 'refcheckdocs' failed make[1]: *** [refcheckdocs] Error 127 Makefile:2094: recipe for target 'refcheckdocs' failed make: *** [refcheckdocs] Error 2 Signed-off-by: Patrick Delaunay <patrick.delaunay at st.com> --- doc/Makefile | 4 ---- 1 file changed, 4 deletions(-)