genhtml: Add option to change HTML footer text

Introduce new command-line option --footer and associated lcovrc
option genhtml_footer that can be used to change the footer text shown
at the bottom of each generated HTML page.

[oberpar: Split original commit, added commit message, fixed typos and
          capitalization, fixed man page short option]

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

Author: henry2cox

Diff for: bin/genhtml

@@ -258,6 +258,7 @@ our $date = get_date_string();
 
 our @info_filenames;	# List of .info files to use as data source
 our $header_title;	# Title at top of HTML report page (above table)
+our $footer;		# String at bottom of HTML report page
 our $test_title;	# Title shown in header table of each page
 our $output_directory;	# Name of directory in which to store output
 our $base_filename;	# Optional name of file containing baseline data
@@ -356,6 +357,7 @@ if ($config || %opt_rc)
 	apply_config({
 		"genhtml_css_file"		=> \$css_filename,
 		"genhtml_header"		=> \$header_title,
+		"genhtml_footer"		=> \$footer,
 		"genhtml_hi_limit"		=> \$hi_limit,
 		"genhtml_med_limit"		=> \$med_limit,
 		"genhtml_line_field_width"	=> \$line_field_width,
@@ -404,6 +406,7 @@ $br_coverage	= $lcov_branch_coverage if (!defined($br_coverage));
 # Parse command line options
 if (!GetOptions("output-directory|o=s"	=> \$output_directory,
 		"header-title=s"        => \$header_title,
+		"footer=s"		=> \$footer,
 		"title|t=s"		=> \$test_title,
 		"description-file|d=s"	=> \$desc_filename,
 		"keep-descriptions|k"	=> \$keep_descriptions,
@@ -632,6 +635,7 @@ HTML output:
   -t, --title TITLE                 Show TITLE in header table of each page
   -c, --css-file CSSFILE            Use external style sheet file CSSFILE
       --header-title BANNER         Banner text at top of each HTML page
+      --footer FOOTER               Footer text at bottom of each HTML page
       --no-source                   Do not create source code view
       --num-spaces NUM              Replace tabs with NUM spaces in source view
       --highlight                   Highlight lines with converted-only data
@@ -4415,13 +4419,14 @@ sub write_html_epilog(*$;$)
 	{
 		$break_code = " target=\"_parent\"";
 	}
+	my $f = defined($main::footer) ? $footer : "Generated by: <a href=\"$lcov_url\"$break_code>$lcov_version</a>";
 
 	# *************************************************************
 
 	write_html($_[0], <<END_OF_HTML)
 	  <table width="100%" border=0 cellspacing=0 cellpadding=0>
 	    <tr><td class="ruler"><img src="$_[1]glass.png" width=3 height=3 alt=""></td></tr>
-	    <tr><td class="versionInfo">Generated by: <a href="$lcov_url"$break_code>$lcov_version</a></td></tr>
+	    <tr><td class="versionInfo">$f</td></tr>
 	  </table>
 	  <br>
 END_OF_HTML

Diff for: lcovrc

@@ -16,6 +16,10 @@
 # Default is "LCOV - coverage report"
 #genhtml_header = Coverage report for my project
 
+# Footer text to use at the bottom of each page
+# Default is LCOV tool version
+#genhtml_footer = My footer text
+
 # Specify coverage rate limits (in %) for classifying file entries
 # HI:   hi_limit <= rate <= 100         graph color: green
 # MED: med_limit <= rate <  hi_limit    graph color: orange

Diff for: man/genhtml.1

@@ -20,6 +20,9 @@ genhtml \- Generate HTML view from LCOV coverage data files
 .RB [ \-\-header-title
 .IR banner ]
 .br
+.RB [ \-\-footer
+.IR string ]
+.br
 .RB [ \-t | \-\-title
 .IR title ]
 .br
@@ -231,6 +234,17 @@ simply identifies this as an LCOV coverage report.
 A potential use is to specify the name of the project or project branch and
 build ID.
 
+.RE
+.BI "\-\-footer " FOOTER
+.RS
+Display
+.I FOOTER
+in footer of all pages.
+
+.I FOOTER
+is written to the footer portion of each generated HTML page.
+The default simply identifies the LCOV tool version used to generate the report.
+
 .RE
 .BI "\-d " description\-file
 .br

Diff for: man/lcovrc.5

@@ -57,6 +57,12 @@ section 'OPTIONS' below.
 # Alternate header text to use at top of each page
 .br
 #genhtml_header = Coverage report for my project
+.br
+
+# Alternate footer text to use at the bottom of each page
+.br
+#genhtml_footer = My footer text
+.br
 
 # Coverage rate limits
 .br
@@ -340,6 +346,19 @@ This option corresponds to the \-\-header\-title command line option of
 Default is "LCOV - coverage report".
 .PP
 
+.BR genhtml_footer " ="
+.I string
+.IP
+Specify footer text to use at bottom of each HTML page.
+.br
+
+This option corresponds to the \-\-footer command line option of
+.BR genhtml .
+.br
+
+Default is LCOV tool version string.
+.PP
+
 .BR genhtml_dark_mode " ="
 .IR  0 | 1
 .IP