1
1

check-help-strings.pl: minor updates

Include the full path to the helpfile in the output message, when
relevant.

This commit was SVN r32451.
Этот коммит содержится в:
Jeff Squyres 2014-08-08 13:32:56 +00:00
родитель eefa17026d
Коммит 82b49c2b9f

Просмотреть файл

@ -157,7 +157,8 @@ foreach my $info (@help_files) {
if (m/^\s*\[(.+?)\]\s*$/) { if (m/^\s*\[(.+?)\]\s*$/) {
my $topic = $1; my $topic = $1;
verbose(" Topic: $topic\n"); verbose(" Topic: $topic\n");
$help_topics->{$info->{short}}->{$topic} = 0; $help_topics->{$info->{short}}->{topic}->{$topic} = 0;
$help_topics->{$info->{short}}->{full} = $info->{full};
++$num_topics; ++$num_topics;
} }
} }
@ -165,7 +166,7 @@ foreach my $info (@help_files) {
if (0 == $num_topics) { if (0 == $num_topics) {
print "*** WARNING: Empty help file (no topics) print "*** WARNING: Empty help file (no topics)
Help file: $info->{short}\n"; Help file: $info->{full}\n";
++$num_warnings; ++$num_warnings;
} }
} }
@ -193,10 +194,11 @@ sub check_file_topic {
} }
# Do we have a topic in that help file for this? # Do we have a topic in that help file for this?
elsif (!exists($help_topics->{$file}->{$topic})) { elsif (!exists($help_topics->{$file}->{topic}->{$topic})) {
print "*** ERROR: Source-referenced help topic does not exist print "*** ERROR: Source-referenced help topic does not exist
Source file: $info->{relative} Source file: $info->{relative}
Help file referenced: $file Help file referenced: $file
which is: $help_topics->{$file}->{full}
Help topic referenced: $topic\n"; Help topic referenced: $topic\n";
++$num_errors; ++$num_errors;
} }
@ -204,7 +206,7 @@ sub check_file_topic {
# Yes, we do have a topic in that help file for this. # Yes, we do have a topic in that help file for this.
# Increase its ref count. # Increase its ref count.
else { else {
++$help_topics->{$file}->{$topic}; ++$help_topics->{$file}->{topic}->{$topic};
} }
} }
@ -260,10 +262,10 @@ print "Checking for stale help messages / files...\n";
foreach my $file (sort(keys(%{$help_topics}))) { foreach my $file (sort(keys(%{$help_topics}))) {
my $num_used = 0; my $num_used = 0;
foreach my $topic (sort(keys(%{$help_topics->{$file}}))) { foreach my $topic (sort(keys(%{$help_topics->{$file}->{topic}}))) {
if (0 == $help_topics->{$file}->{$topic}) { if (0 == $help_topics->{$file}->{topic}->{$topic}) {
print "*** WARNING: Possibly unused help topic print "*** WARNING: Possibly unused help topic
Help file: $file Help file: $help_topics->{$file}->{full}
Help topic: $topic\n"; Help topic: $topic\n";
++$num_warnings; ++$num_warnings;
} else { } else {
@ -274,7 +276,7 @@ foreach my $file (sort(keys(%{$help_topics}))) {
# Were no topics used in this file at all? # Were no topics used in this file at all?
if (0 == $num_used) { if (0 == $num_used) {
print "*** WARNING: Possibly unused help file (no topics used from this file) print "*** WARNING: Possibly unused help file (no topics used from this file)
Help file: $file\n"; Help file: $help_topics->{$file}->{full}\n";
++$num_warnings; ++$num_warnings;
} }
} }