linux-toradex.git/scripts/documentation-file-ref-check, branch v4.18

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

2018-06-15T21:10:01+00:00

Some files, like tools/memory-model/README has references to
a Documentation file that is locale to it. Handle references
that are relative to them too.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

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

2018-06-15T21:10:01+00:00

Now that the number of broken refs are smaller, improve the logic
that gets rid of false-positives.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

scripts/documentation-file-ref-check: hint: dash or underline

2018-06-15T21:10:01+00:00

Sometimes, people use dash instead of underline or vice-versa.
Try to autocorrect it.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

scripts/documentation-file-ref-check: add a fix logic for DT

2018-06-15T21:10:01+00:00

There are several links broken due to DT file movements. Add
a hint logic to seek for those changes.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

scripts/documentation-file-ref-check: accept more wildcards at filenames

2018-06-15T21:10:01+00:00

at MAINTAINERS, some filename paths use '?' and things like [7,9].
So, accept more wildcards, in order to avoid false-positives.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

scripts/documentation-file-ref-check: fix help message

2018-06-15T21:10:01+00:00

The name of the --fix option was renamed, but it was not
changed at the quick help message.

Signed-off-by: Mauro Carvalho Chehab 
Acked-by: Jonathan Corbet

scripts/documentation-file-ref-check: rewrite it in perl with auto-fix mode

2018-05-10T21:42:43+00:00

The original shell script works, but:
	1) it is too slow;
	2) it is hard to exclude rejex patterns

Convert it to perl.

Here, the new version is able to check the entire tree in
less than a second (after cached):

	real	0m0,284s
	user	0m0,668s
	sys	0m0,778s

The old version takes more than a minute to complete (also
after cached):
	real	1m17,905s
	user	0m25,583s
	sys	0m55,334s

It also produce less false-positives (if any).

The new script also contains an auto-fix mode.

Usually, file references get lost when they're moved to some other
place and/or renamed to .rst.

Add an experimental mode to auto-fix those.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

Documentation: add script and build target to check for broken file references

2017-10-12T17:07:42+00:00

Add a simple script and build target to do a treewide grep for
references to files under Documentation, and report the non-existing
file in stderr. It tries to take into account punctuation not part of
the filename, and wildcards, but there are bound to be false positives
too. Mostly seems accurate though.

We've moved files around enough to make having this worthwhile.

Signed-off-by: Jani Nikula 
Signed-off-by: Jonathan Corbet