lkml.org 
[lkml]   [2018]   [Jun]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH v3 14/27] scripts/documentation-file-ref-check: get rid of false-positives
    Date
    Now that the number of broken refs are smaller, improve the logic
    that gets rid of false-positives.

    Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
    ---
    scripts/documentation-file-ref-check | 21 ++++++++++++++++++---
    1 file changed, 18 insertions(+), 3 deletions(-)

    diff --git a/scripts/documentation-file-ref-check b/scripts/documentation-file-ref-check
    index d132f756d31d..047f463cdf4b 100755
    --- a/scripts/documentation-file-ref-check
    +++ b/scripts/documentation-file-ref-check
    @@ -38,16 +38,31 @@ while (<IN>) {
    my $f = $1;
    my $ln = $2;

    - # Makefiles contain nasty expressions to parse docs
    - next if ($f =~ m/Makefile/);
    + # Makefiles and scripts contain nasty expressions to parse docs
    + next if ($f =~ m/Makefile/ || $f =~ m/\.sh$/);
    +
    # Skip this script
    next if ($f eq $scriptname);

    - if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*),) {
    + if ($ln =~ m,\b(\S*)(Documentation/[A-Za-z0-9\_\.\,\~/\*\[\]\?+-]*)(.*),) {
    my $prefix = $1;
    my $ref = $2;
    my $base = $2;
    + my $extra = $3;

    + # some file references are like:
    + # /usr/src/linux/Documentation/DMA-{API,mapping}.txt
    + # For now, ignore them
    + next if ($extra =~ m/^{/);
    +
    + # Remove footnotes at the end like:
    + # Documentation/devicetree/dt-object-internal.txt[1]
    + $ref =~ s/(txt|rst)\[\d+]$/$1/;
    +
    + # Remove ending ']' without any '['
    + $ref =~ s/\].*// if (!($ref =~ m/\[/));
    +
    + # Remove puntuation marks at the end
    $ref =~ s/[\,\.]+$//;

    my $fulref = "$prefix$ref";
    --
    2.17.1
    \
     
     \ /
      Last update: 2018-06-14 18:15    [W:3.660 / U:0.040 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site