Fix check-doxy-blocks.pl to run from root dir

Modify tests/scripts/check-doxy-blocks.pl to ensure that:
  * It can only be run from the mbed TLS root directory.
  * An error code is returned to the environment when a potential error
    in the source code is found.
This commit is contained in:
Andres Amaya Garcia 2016-12-14 09:36:55 +00:00 committed by Simon Butcher
parent 5634b8609b
commit d3f0f5e1c8

View File

@ -19,6 +19,10 @@ my @directories = qw(include/mbedtls library doxygen/input);
# everything with a backslach except '\0' and backslash at EOL # everything with a backslach except '\0' and backslash at EOL
my $doxy_re = qr/\\(?!0|\n)/; my $doxy_re = qr/\\(?!0|\n)/;
# Return an error code to the environment if a potential error in the
# source code is found.
my $exit_code = 0;
sub check_file { sub check_file {
my ($fname) = @_; my ($fname) = @_;
open my $fh, '<', $fname or die "Failed to open '$fname': $!\n"; open my $fh, '<', $fname or die "Failed to open '$fname': $!\n";
@ -32,6 +36,7 @@ sub check_file {
if ($block_start and $line =~ m/$doxy_re/) { if ($block_start and $line =~ m/$doxy_re/) {
print "$fname:$block_start: directive on line $.\n"; print "$fname:$block_start: directive on line $.\n";
$block_start = 0; # report only one directive per block $block_start = 0; # report only one directive per block
$exit_code = 1;
} }
} }
@ -45,13 +50,15 @@ sub check_dir {
} }
} }
# locate root directory based on invocation name # Check that the script is being run from the project's root directory.
my $root = dirname($0) . '/..';
chdir $root or die "Can't chdir to '$root': $!\n";
# just do it
for my $dir (@directories) { for my $dir (@directories) {
check_dir($dir) if (! -d $dir) {
die "This script must be run from the mbed TLS root directory";
} else {
check_dir($dir)
}
} }
exit $exit_code;
__END__ __END__