[PATCH 0/2] Two fixes for documentation-file-ref-check

[PATCH 0/2] Two fixes for documentation-file-ref-check

[Mauro Carvalho Chehab]

Hi Jon,

This small series contain two fixes for  documentation-file-ref-check,
in order to remove some (false) positives.

The first one makes it to ignore files that start with a dot. It
prevents the script to try parsing hidden files. 

The second one shuts up (currently) two false-positives for some
documents under:

	tools/bpf/bpftool/Documentation/

Mauro Carvalho Chehab (2):
  scripts: documentation-file-ref-check: ignore hidden files
  scripts: documentation-file-ref-check: fix bpf selftests path

 scripts/documentation-file-ref-check | 4 ++++
 1 file changed, 4 insertions(+)

-- 
2.31.1

[PATCH 1/2] scripts: documentation-file-ref-check: ignore hidden files

[Mauro Carvalho Chehab]

There's a warning there from a .gitignore file:

	tools/perf/.gitignore: Documentation/doc.dep

This is not really a cross-reference type of warning, so
no need to report it.

In a matter of fact, it doesn't make sense at all to even
parse hidden files, as some text editors may create such
files for their own usage.

So, just ignore everything that matches this pattern:

	/\.*

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---

To mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1634629094.git.mchehab+huawei@kernel.org/

 scripts/documentation-file-ref-check | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index 7187ea5e5149..6865d8e63d5c 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -94,6 +94,9 @@ while (<IN>) {
 	# Makefiles and scripts contain nasty expressions to parse docs
 	next if ($f =~ m/Makefile/ || $f =~ m/\.sh$/);
 
+	# It doesn't make sense to parse hidden files
+	next if ($f =~ m#/\.#);
+
 	# Skip this script
 	next if ($f eq $scriptname);
 
-- 
2.31.1

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

[Mauro Carvalho Chehab]

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 <mchehab+huawei@kernel.org>
---

To mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 0/2] at: https://lore.kernel.org/all/cover.1634629094.git.mchehab+huawei@kernel.org/

 scripts/documentation-file-ref-check | 1 +
 1 file changed, 1 insertion(+)

diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
index 6865d8e63d5c..68083f2f1122 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -147,6 +147,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"));
 		}
 
-- 
2.31.1

Re: [PATCH 0/2] Two fixes for documentation-file-ref-check

[Jonathan Corbet]

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> Hi Jon,
>
> This small series contain two fixes for  documentation-file-ref-check,
> in order to remove some (false) positives.
>
> The first one makes it to ignore files that start with a dot. It
> prevents the script to try parsing hidden files. 
>
> The second one shuts up (currently) two false-positives for some
> documents under:
>
> 	tools/bpf/bpftool/Documentation/
>
> Mauro Carvalho Chehab (2):
>   scripts: documentation-file-ref-check: ignore hidden files
>   scripts: documentation-file-ref-check: fix bpf selftests path
>
>  scripts/documentation-file-ref-check | 4 ++++
>  1 file changed, 4 insertions(+)

Set applied, thanks.

jon