Changes in documentation-file-ref-check

790ca8b0 - scripts/documentation-file-ref-check: don't check perl/python scripts

Mon, 10 Feb 2025 10:17:58 +0000

scripts/documentation-file-ref-check: don't check perl/python scriptsSuch scripts may have regular expressions, which would make theparser confusing. Also, they shouldn't hardcode filenames there,so skipping them is OK.While here, also don't check references on extensions used for filebackup and patch rej/orig.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Link: https://lore.kernel.org/r/712bfc8412ee5ad8ab43dd21a8c30fc858eff5a6.1739182025.git.mchehab+huawei@kernel.org List of files: /linux-6.15/scripts/documentation-file-ref-check

6e74e68d - scripts: documentation-file-ref-check: fix bpf selftests path

Tue, 19 Oct 2021 07:42:51 +0000

scripts: documentation-file-ref-check: fix bpf selftests pathtools/testing/selftests/bpf/test_bpftool_synctypes.py userelative 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/bpftoolIn order to properly check the files used by such script.Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/49b765cbac6ccd22d627573154806ec9389d60f0.1634629094.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

14efb275 - scripts: documentation-file-ref-check: ignore hidden files

Tue, 19 Oct 2021 07:42:50 +0000

scripts: documentation-file-ref-check: ignore hidden filesThere's a warning there from a .gitignore file: tools/perf/.gitignore: Documentation/doc.depThis is not really a cross-reference type of warning, sono need to report it.In a matter of fact, it doesn't make sense at all to evenparse hidden files, as some text editors may create suchfiles for their own usage.So, just ignore everything that matches this pattern: /\.*Signed-off-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/dd0125a931b4fecf8fab6be8aa527faa18f78e43.1634629094.git.mchehab+huawei@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

709dedfd - documentation-file-ref-check: Make git check work for multiple working directories

Thu, 03 Jun 2021 01:28:06 +0000

documentation-file-ref-check: Make git check work for multiple working directoriesWith multiple git working directories, '.git' may also be a text filelinking to the actual git tree instead of a directory.Cc: Mauro Carvalho Chehab Cc: Jonathan Corbet Cc: linux-doc@vger.kernel.orgSigned-off-by: Rob Herring Reviewed-by: Mauro Carvalho Chehab Tested-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/20210603012806.331132-1-robh@kernel.orgSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

d98dbbe0 - scripts: documentation-file-ref-check: Add line break before exit

Tue, 14 Apr 2020 09:41:48 +0000

scripts: documentation-file-ref-check: Add line break before exitIf execute ./scripts/documentation-file-ref-check in a directory which isnot a git tree, it will exit without a line break, fix it.Without this patch:[loongson@localhost linux-5.7-rc1]$ ./scripts/documentation-file-ref-checkWarning: can't check if file exists, as this is not a git tree[loongson@localhost linux-5.7-rc1]$With this patch:[loongson@localhost linux-5.7-rc1]$ ./scripts/documentation-file-ref-checkWarning: can't check if file exists, as this is not a git tree[loongson@localhost linux-5.7-rc1]$Signed-off-by: Tiezhu Yang Reviewed-by: Mauro Carvalho Chehab Link: https://lore.kernel.org/r/1586857308-2040-1-git-send-email-yangtiezhu@loongson.cnSigned-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

ce5c5d65 - scsi: docs: convert scsi_mid_low_api.txt to ReST

Mon, 02 Mar 2020 08:16:04 +0000

scsi: docs: convert scsi_mid_low_api.txt to ReSTLink: https://lore.kernel.org/r/881e7741dfed5d6f5f73e1dfc2826b200b8604aa.1583136624.git.mchehab+huawei@kernel.orgSigned-off-by: Mauro Carvalho Chehab Signed-off-by: Martin K. Petersen List of files: /linux-6.15/scripts/documentation-file-ref-check

290d5388 - scripts: documentation-file-ref-check: improve :doc: handling

Sat, 22 Feb 2020 09:00:01 +0000

scripts: documentation-file-ref-check: improve :doc: handlingThere are some issues at the script with regards to :doc:tags:- It doesn't escape files under Documentation/sphinx, leading to false positives;- It doesn't handle root URLs, like :doc:`/x86/boot`;- It doesn't output the file with a bad reference.Address those things, in order to remove false positivesfrom the list of problems.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

407b584d - scripts/documentation-file-ref-check: ignore output dir

Thu, 13 Jun 2019 10:29:17 +0000

scripts/documentation-file-ref-check: ignore output dirWhen there's no Documentation/output directory, the script willcomplain about those missing references: Documentation/doc-guide/sphinx.rst: Documentation/output Documentation/doc-guide/sphinx.rst: Documentation/output Documentation/process/howto.rst: Documentation/output Documentation/translations/it_IT/doc-guide/sphinx.rst: Documentation/output Documentation/translations/it_IT/doc-guide/sphinx.rst: Documentation/output Documentation/translations/it_IT/process/howto.rst: Documentation/output Documentation/translations/ja_JP/howto.rst: Documentation/output Documentation/translations/ko_KR/howto.rst: Documentation/outputThose are false positives, so add an ignore rule for them.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

4ca9bc22 - docs: target: convert docs to ReST and rename to *.rst

Wed, 12 Jun 2019 17:52:59 +0000

docs: target: convert docs to ReST and rename to *.rstConvert the TCM docs to ReST format and add them to thebookset.This has a mix of userspace-faced and Kernelspace faceddocs. Still, it sounds a better candidate to be added atthe kernel API set of docs.The conversion is actually: - add blank lines and identation in order to identify paragraphs; - fix tables markups; - add some lists markups; - mark literal blocks; - adjust title markups.At its new index.rst, let's add a :orphan: while this is not linked tothe main index.rst file, in order to avoid build warnings.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

b1663d7e - docs: Kbuild/Makefile: allow check for missing docs at build time

Tue, 04 Jun 2019 12:26:27 +0000

docs: Kbuild/Makefile: allow check for missing docs at build timeWhile this doesn't make sense for production Kernels, in order toavoid regressions when documents are touched, let's add acheck target at the make file.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

0ca862e6 - scripts/documentation-file-ref-check: teach about .txt -> .yaml renames

Wed, 29 May 2019 23:09:30 +0000

scripts/documentation-file-ref-check: teach about .txt -> .yaml renamesAt DT, files are being renamed to jason. Teach the script how tohandle such renames when used in fix mode.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

4904aeed - scripts/documentation-file-ref-check: improve tools ref handling

Wed, 29 May 2019 23:09:29 +0000

scripts/documentation-file-ref-check: improve tools ref handlingThere's a false positive on perf/util: tools/perf/util/s390-cpumsf.c: Documentation/perf.data-file-format.txtThe file is there at tools/perf/Documentation/, but the logicwith detects relative documentation references inside tools isnot capable of detecting it.So, improve it.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

aeaacbfe - scripts/documentation-file-ref-check: exclude false-positives

Wed, 29 May 2019 23:09:28 +0000

scripts/documentation-file-ref-check: exclude false-positivesThere are at least two cases where a documentation file was gonefor good, but the text still mentions it:1) drivers/vhost/vhost.c: the reference for Documentation/virtual/lguest/lguest.c is just to give credits to the original work that vhost replaced;2) Documentation/scsi/scsi_mid_low_api.txt: It gives credit and mentions the old Documentation/Configure.help file that used to be part of Kernel 2.4.xAs we don't want to keep the script to keep pinpoint to thoseevery time, let's add a logic at the script to allow it to ignorevalid false-positives like the above.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

9e78e7fc - scripts/documentation-file-ref-check: better handle translations

Wed, 29 May 2019 23:09:27 +0000

scripts/documentation-file-ref-check: better handle translationsOnly seek for translation renames inside the translationdirectory.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

894ee5ff - scripts/documentation-file-ref-check: detect broken :doc:`foo`

Wed, 24 Apr 2019 16:25:33 +0000

scripts/documentation-file-ref-check: detect broken :doc:`foo`As we keep migrating documents to ReST, we're starting to seemore of such tags.Right now, all such tags are pointing to a documentation file,but regressions may be introduced.So, add a check for such kind of issues as well.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

fe3e4b9c - scripts/documentation-file-ref-check: don't parse Next/ dir

Mon, 22 Apr 2019 11:42:02 +0000

scripts/documentation-file-ref-check: don't parse Next/ dirIf one tries to run this script under linux-next, it wouldhit lots of false-positives, due to the tree merges thatare stored under the Next/ directory.So, add a logic to ignore it.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

5d395fa6 - scripts/documentation-file-ref-check: ignore sched-pelt false positive

Tue, 26 Jun 2018 09:49:04 +0000

scripts/documentation-file-ref-check: ignore sched-pelt false positiveWhen Documentation/scheduler/sched-pelt.c is compiled, it generatesa file called Documentation/scheduler/sched-pelt. As this onlyexists after building such tool, we need an explict checkto remove the false-positive.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

d25c0634 - scripts/documentation-file-ref-check: remove some false positives

Tue, 26 Jun 2018 09:49:03 +0000

scripts/documentation-file-ref-check: remove some false positivesThere are several false positives at tcm_mod_builder.txt: Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000 Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000 Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_base.h Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../include/target/target_core_fabric_ops.h Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.c Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_fabric.h Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/tcm_nab5000_configfs.c Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/Kbuild Documentation/target/tcm_mod_builder.txt: mnt/sdb/lio-core-2.6.git/Documentation/target/../../drivers/target/tcm_nab5000/KconfigIgnore them.Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

a78513c6 - scripts/documentation-file-ref-check: check tools/*/Documentation

Thu, 14 Jun 2018 14:06:08 +0000

scripts/documentation-file-ref-check: check tools/*/DocumentationSome files, like tools/memory-model/README has references toa Documentation file that is locale to it. Handle referencesthat are relative to them too.Signed-off-by: Mauro Carvalho Chehab Acked-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check

2d69708f - scripts/documentation-file-ref-check: get rid of false-positives

Thu, 14 Jun 2018 13:47:29 +0000

scripts/documentation-file-ref-check: get rid of false-positivesNow that the number of broken refs are smaller, improve the logicthat gets rid of false-positives.Signed-off-by: Mauro Carvalho Chehab Acked-by: Jonathan Corbet List of files: /linux-6.15/scripts/documentation-file-ref-check