03 Jul, 2018

2 commits

• 5d395fa63   scripts/documentation-file-ref-check: ignore sched-pelt false positive ... Browse Code »

  When Documentation/scheduler/sched-pelt.c is compiled, it generates
  a file called Documentation/scheduler/sched-pelt. As this only
  exists after building such tool, we need an explict check
  to remove the false-positive.

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

  Mauro Carvalho Chehab

  2018-07-03 01:25:00 +0800  
• d25c06344   scripts/documentation-file-ref-check: remove some false positives ... Browse Code »

  There 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/Kconfig

  Ignore them.

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

  Mauro Carvalho Chehab

  2018-07-03 01:24:24 +0800  

16 Jun, 2018

6 commits

• a78513c67   scripts/documentation-file-ref-check: check tools/*/Documentation ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  
• 2d69708f9   scripts/documentation-file-ref-check: get rid of false-positives ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  
• e1f319fe4   scripts/documentation-file-ref-check: hint: dash or underline ... Browse Code »

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

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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  
• be600e5ac   scripts/documentation-file-ref-check: add a fix logic for DT ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  
• 504402400   scripts/documentation-file-ref-check: accept more wildcards at filenames ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  
• 40fc3eb05   scripts/documentation-file-ref-check: fix help message ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-06-16 05:10:01 +0800  

11 May, 2018

1 commit

• d26560950   scripts/documentation-file-ref-check: rewrite it in perl with auto-fix mode ... Browse Code »

  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

  Mauro Carvalho Chehab

  2018-05-11 05:42:43 +0800  

13 Oct, 2017

1 commit

• e8939222d   Documentation: add script and build target to check for broken file references ... Browse Code »

  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

  Jani Nikula

  2017-10-13 01:07:42 +0800