Skip to content

Doc clarification #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 11, 2025
Merged

Doc clarification #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0f68b3
Somewhat simpler code/easier to read.
henry2cox Jul 31, 2025
c8bf750
Attempt to clarify 'genhtml --diff-file' usage. See #425.
henry2cox Aug 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/lcovutil.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2102,14 +2102,14 @@ sub update_state
while (my ($f, $v) = each(%$updateVersionCache)) {
lcovutil::ignorable_error($lcovutil::ERROR_INTERNAL,
"unexpected version entry")
if exists($versionCache{$f}) && !($versionCache{$f} eq $v);
if exists($versionCache{$f}) && $versionCache{$f} ne $v;
$versionCache{$f} = $v;
}
my $updateResolveCache = shift;
while (my ($f, $v) = each(%$updateResolveCache)) {
lcovutil::ignorable_error($lcovutil::ERROR_INTERNAL,
"unexpected resolve entry")
if exists($resolveCache{$f}) && !($resolveCache{$f} eq $v);
if exists($resolveCache{$f}) && $resolveCache{$f} ne $v;
$resolveCache{$f} = $v;
}
my $msgTypes = shift;
Expand Down Expand Up @@ -5102,7 +5102,7 @@ sub removeBranches

sub _checkCounts
{
# some consistenc checking
# some consistency checking
my $self = shift;

my $data = $self->[BranchMap::DATA];
Expand Down
25 changes: 15 additions & 10 deletions man/genhtml.1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1158,16 +1158,13 @@ callback to verify that source versions match before source-based filtering is a
It is almost always a better idea to filter at capture or aggregate time - not at report generation.

A suitable
.I diff\-file
can be generated using the command:
.br

.RS
git diff \-\-relative <SHA_base> <SHA_current>
.RE
.I \"universal diff\"
input file for the
.I \-\-diff\-file
option
can be generated using either the "p4udiff" or "gitdiff" sample scripts that are provided as part of this package, or by using revision control commands directly.

or using the "p4udiff" or "gitdiff" sample scripts that are provided as part of this package in the following locations:
.br
The "p4udiff" or "gitdiff" sample scripts are found in:

.RS
\*[scriptdir]/p4udiff
Expand All @@ -1181,10 +1178,18 @@ and
.br
.RE


These scripts simply post\-process the 'p4' or 'git' output to (optionally) remove files that are not of interest and to explicitly note files which have not changed.

.B p4udiff
accepts either a changelist ID or the literal string "sandbox"; "sandbox" indicates that there are modified files which have not been checked in.
See "
.I gitdiff \-\- help
" and "
.I p4udiff \-\- help
" for more information.

These scripts post\-process the 'p4' or 'git' output to (optionally) remove files that are not of interest and to explicitly note files which have not changed. It is useful to note unchanged files denoted by lines of the form:
It is useful to note unchanged files denoted by lines of the form:
.br

.RS
Expand Down