[PATCH] scripts/documentation-file-ref-check: ignore output dir

[PATCH] scripts/documentation-file-ref-check: ignore output dir

[Mauro Carvalho Chehab]

When there's no Documentation/output directory, the script will
complain 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/output

Those are false positives, so add an ignore rule for them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@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 a4139a576726..7784c54aa38b 100755
--- a/scripts/documentation-file-ref-check
+++ b/scripts/documentation-file-ref-check
@@ -90,6 +90,9 @@ while (<IN>) {
 	# Skip this script
 	next if ($f eq $scriptname);
 
+	# Ignore the dir where documentation will be built
+	next if ($ln =~ m,\b(\S*)Documentation/output,);
+
 	if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
 		my $prefix = $1;
 		my $ref = $2;
-- 
2.21.0

Re: [PATCH] scripts/documentation-file-ref-check: ignore output dir

[Jonathan Corbet]

On Thu, 13 Jun 2019 07:29:17 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> When there's no Documentation/output directory, the script will
> complain 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/output
> 
> Those are false positives, so add an ignore rule for them.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Applied, thanks.

jon