aboutsummaryrefslogtreecommitdiffstats
path: root/scripts/sphinx2tasks.pl
blob: 3cf41d70b65a5969f36018e381276a75f9e94b46 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
#!/usr/bin/perl

# Copyright (C) 2018 The Qt Company Ltd.
# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

=head1 NAME

sphinx2tasks.pl - Convert sphinx (Python documentation) warnings into Qt Creator task files.

=head1 SYNOPSIS

    sphinx2tasks.pl < logfile > taskfile

=cut

use strict;
use warnings;

my $count = 0;

while (my $line = <STDIN>) {
    chomp($line);
    # Strip terminal control characters
    my $len = length($line);
    $line = substr($line, 5, $len - 17) if ($len > 0 && ord(substr($line, 0, 1)) == 0x1B);
    # --- extract file name based matching:
    # file.rst:698: WARNING: undefined label: xquer (if the link....)
    if ($line =~ /^[^\/]*([^:]+)\.(rst|md):(\d*): (WARNING|CRITICAL): (.*)$/) {
        my $fileName = $1 . '.' . $2;
        my $lineNumber = $3 eq '' ? '1' : $3;
        my $level = $4 eq 'CRITICAL' ? 'error' : 'warn';
        my $text = $5;
        print $fileName, "\t", $lineNumber, "\t", $level, "\t", $text,"\n";
        ++$count;
    }
}

print STDERR $count, " issue(s) found.\n" if $count;