Add message type 'usage' to report tool usage/parameter issues

Signed-off-by: Henry Cox <[email protected]>

Author: henry2cox

bin/genhtml

@@ -5499,11 +5499,11 @@ if (@SourceFile::annotateScript) {
 }
 if (0 != (defined($diff_filename) ^ (0 != scalar(@base_filenames)))) {
     if (@base_filenames) {
-        warn(
+        lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
             "Specified --baseline-file without --diff-file: assuming no source differences.  Hope that is OK.\n"
         );
     } else {
-        warn(
+        lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
             "Specified --diff-file without --baseline-file: assuming baseline code coverage was empty (nothing covered).  Hope that is OK\n"
         );
         # OK..just assume that the baseline is empty...
@@ -5633,14 +5633,15 @@ $html_epilog = get_html_epilog($html_epilog_file);
 
 # Issue a warning if --no-sourceview is enabled together with --frames
 if ($no_sourceview && defined($frames)) {
-    warn("option --frames disabled because --no-sourceview " .
-         "was specified!\n");
+    lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
+             "option --frames disabled because --no-sourceview was specified.");
     $frames = undef;
 }
 
 # Issue a warning if --no-prefix is enabled together with --prefix
 if ($no_prefix && @dir_prefix) {
-    warn("option --prefix disabled because --no-prefix was " . "specified!\n");
+    lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
+                    "option --prefix disabled because --no-prefix was ignored");
     @dir_prefix = undef;
 }
 

bin/geninfo

@@ -424,8 +424,8 @@ if ($gcov_version >= (9 << 16) &&
 if ($intermediate) {
     info("Using intermediate gcov format\n");
     if ($opt_derive_func_data) {
-        warn("--derive-func-data is not compatible with " .
-             "intermediate format - ignoring\n");
+        lcovutil::ignorable_error($lcovutil::ERROR_USAGE,
+               "--derive-func-data is not compatible with intermediate format");
         $opt_derive_func_data = 0;
     }
     if ($lcovutil::exclude_exception_branch && !$gcov_caps->{'json-format'}) {
@@ -578,7 +578,8 @@ foreach my $dir (@lcovutil::internal_dirs) {
 }
 
 if ($initial && $lcovutil::br_coverage && !$intermediate) {
-    warn("--initial does not generate branch coverage data\n");
+    lcovutil::ignorable_error($lcovutil::ERROR_USAGE,
+                            "--initial does not generate branch coverage data");
 }
 
 # where to write parallel child data
@@ -1018,6 +1019,11 @@ sub gen_info(@)
     my %files;
     my $total = 0;
     foreach my $directory (@_) {
+        unless (-e $directory) {
+            lcovutil::ignorable_error($lcovutil::ERROR_USAGE,
+                                      "no such file or directory '$directory'");
+            next;
+        }
         if (-d $directory) {
             info("Scanning $directory for $ext files ...\n");
 
@@ -1040,22 +1046,37 @@ sub gen_info(@)
             # keep track of directory where we found the file
             foreach my $entry (@found) {
                 if (exists($files{$entry})) {
-                    warn("duplicate file $directory in both $directory and " .
-                         $files{$entry} . "\n");
+                    lcovutil::ignorable_error(
+                        $lcovutil::ERROR_USAGE,
+                        "duplicate file $entry in both $files{$entry} and $directory"
+                            .
+                            (lcovutil::is_ignored($lcovutil::ERROR_USAGE) ?
+                                 ' (skip latter)' :
+                                 ''));
+                    next;
                 } else {
                     ++$total;
                 }
                 $files{$entry} = $directory;
             }
         } else {
-            die("no such file or directory '$directory'")
-                unless (-e $directory);
+            my ($name, $d, $e) = fileparse($directory, qr/\.[^.]*/);
+            if ($e ne $ext) {
+                lcovutil::ignorable_error($lcovutil::ERROR_USAGE,
+                       "$directory has unsupported extension: expected '$ext'" .
+                           ($initial ? " for initial capture" : ""));
+                next;
+            }
             # use the directory where we find the file as the base dir
-            my $d = dirname($directory);
-
             if (exists($files{$directory})) {
-                warn("duplicate file $directory in both $d and " .
-                     $files{$directory} . "\n");
+                lcovutil::ignorable_error(
+                   $lcovutil::ERROR_USAGE,
+                   "duplicate file $directory in both $files{$directory} and $d"
+                       .
+                       (lcovutil::is_ignored($lcovutil::ERROR_USAGE) ?
+                            ' (skip latter)' :
+                            ''));
+                next;
             } else {
                 ++$total;
             }
@@ -1098,9 +1119,6 @@ sub gen_info(@)
         lcovutil::info(2, "schedule %s in %d\n", $filename, scalar(@worklist));
         # find the corresponding gcno file...
         my ($name, $d, $e) = fileparse($filename, qr/\.[^.]*/);
-        die("unexpected extension '$e': should be $ext" .
-            ($initial ? " for initial capture" : ""))
-            unless ($e eq $ext);
         my ($gcda_file, $gcno_file);
         if ($initial) {
             $gcno_file = $filename;

bin/lcov

@@ -290,7 +290,8 @@ if (!($lcovutil::lcov_capture || @add_tracefile) &&
     foreach my $e (@lcovutil::extractVersionScript) {
         $e = "'$e'" if ($e =~ /\s/);
     }
-    warn("--version-script ignored except with --capture or --add-tracefile");
+    lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
+           "--version-script ignored except with --capture or --add-tracefile");
 }
 
 # Check list width option
@@ -324,7 +325,8 @@ if (@ARGV &&
 
 if (defined($lcovutil::opt_no_external) &&
     !(defined($lcovutil::lcov_capture) && $lcovutil::lcov_capture != 0)) {
-    warn("'--no-external' is ignored except in 'lcov --capture|-c'\n");
+    lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
+                  "'--no-external' is ignored except in 'lcov --capture|-c'\n");
     $lcovutil::opt_no_external = 0;
 }
 
@@ -616,7 +618,8 @@ sub userspace_reset()
         my $count = 0;
         foreach my $current_dir (@dirs) {
             if (!-d $current_dir) {
-                warn("$current_dir is not a directory - skpping\n");
+                lcovutil::ignorable_error($lcovutil::ERROR_USAGE,
+                                          "$current_dir is not a directory");
                 next;
             }
             ++$count;

lib/lcovutil.pm

@@ -66,7 +66,7 @@ our @EXPORT_OK = qw($tool_name $tool_dir $lcov_version $lcov_url
      $ERROR_BRANCH $ERROR_EMPTY $ERROR_FORMAT $ERROR_VERSION $ERROR_UNUSED
      $ERROR_PACKAGE $ERROR_CORRUPT $ERROR_NEGATIVE $ERROR_COUNT
      $ERROR_UNSUPPORTED $ERROR_DEPRECATED $ERROR_INCONSISTENT_DATA
-     $ERROR_CALLBACK $ERROR_RANGE $ERROR_UTILITY
+     $ERROR_CALLBACK $ERROR_RANGE $ERROR_UTILITY $ERROR_USAGE
      $ERROR_PARALLEL report_parallel_error
      $stop_on_error
 
@@ -123,6 +123,7 @@ our $ERROR_CALLBACK          = 16; # callback produced an error
 our $ERROR_INCONSISTENT_DATA = 17; # somthing wrong with .info
 our $ERROR_RANGE             = 18; # line number out of range
 our $ERROR_UTILITY           = 19; # some tool failed - e.g., 'find'
+our $ERROR_USAGE             = 20; # misusing some feature
 
 our %geninfoErrs = ("gcov"         => $ERROR_GCOV,
                     "source"       => $ERROR_SOURCE,
@@ -143,6 +144,7 @@ our %geninfoErrs = ("gcov"         => $ERROR_GCOV,
                     "deprecated"   => $ERROR_DEPRECATED,
                     "callback"     => $ERROR_CALLBACK,
                     'utility'      => $ERROR_UTILITY,
+                    'usage'        => $ERROR_USAGE,
                     "package"      => $ERROR_PACKAGE,);
 our $stop_on_error;    # attempt to keep going
 our $warn_once_per_file = 1;
@@ -1205,8 +1207,8 @@ sub munge_file_patterns
                         last;
                     }
                 }
-                warn(
-                    "--$flag pattern '$pat' does not seem to be case insensitive - but you asked for case insenstive matching\n"
+                lcovutil::ignorable_warning($lcovutil::ERROR_USAGE,
+                    "--$flag pattern '$pat' does not seem to be case insensitive - but you asked for case insenstive matching"
                 );
             }
         }

man/genhtml.1

@@ -2198,6 +2198,9 @@ The requested feature is not supported for this tool configuration.  For example
 The include/exclude/erase/substitute/omit pattern did not match any file pathnames.
 .br
 
+.B usage:
+unsupported usage detected - e.g. an unsupported option combination.
+
 .B utility:
 a tool called during processing returned an error code (e.g., 'find' encountered an unreadable directory).
 

man/geninfo.1

@@ -789,6 +789,9 @@ the requested feature is not supported for this tool configuration.  For example
 .B unused:
 the include/exclude/erase/omit/substitute pattern did not match any file pathnames.
 
+.B usage:
+unsupported usage detected - e.g. an unsupported option combination.
+
 .B utility:
 a tool called during processing returned an error code (e.g., 'find' encountered an unreadable directory).
 

man/lcov.1

@@ -1132,6 +1132,9 @@ the requested feature is not supported for this tool configuration.  For example
 .B unused:
 the include/exclude/erase/omit/substitute pattern did not match any file pathnames.
 
+.B usage:
+unsupported usage detected - e.g. an unsupported option combination.
+
 .B utility:
 a tool called during processing returned an error code (e.g., 'find' encountered an unreadable directory).