Skip to content

Commit 106aabb

Browse files
committed
Attempt to clarify 'genhtml --diff-file' usage. See #425.
Signed-off-by: Henry Cox <[email protected]>
1 parent c4729e5 commit 106aabb

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

lib/lcovutil.pm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5102,7 +5102,7 @@ sub removeBranches
51025102

51035103
sub _checkCounts
51045104
{
5105-
# some consistenc checking
5105+
# some consistency checking
51065106
my $self = shift;
51075107

51085108
my $data = $self->[BranchMap::DATA];

man/genhtml.1

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1158,16 +1158,13 @@ callback to verify that source versions match before source-based filtering is a
11581158
It is almost always a better idea to filter at capture or aggregate time - not at report generation.
11591159

11601160
A suitable
1161-
.I diff\-file
1162-
can be generated using the command:
1163-
.br
1164-
1165-
.RS
1166-
git diff \-\-relative <SHA_base> <SHA_current>
1167-
.RE
1161+
.I \"universal diff\"
1162+
input file for the
1163+
.I \-\-diff\-file
1164+
option
1165+
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.
11681166

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

11721169
.RS
11731170
\*[scriptdir]/p4udiff
@@ -1181,10 +1178,18 @@ and
11811178
.br
11821179
.RE
11831180

1181+
1182+
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.
1183+
11841184
.B p4udiff
11851185
accepts either a changelist ID or the literal string "sandbox"; "sandbox" indicates that there are modified files which have not been checked in.
1186+
See "
1187+
.I gitdiff \-\- help
1188+
" and "
1189+
.I p4udiff \-\- help
1190+
" for more information.
11861191

1187-
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:
1192+
It is useful to note unchanged files denoted by lines of the form:
11881193
.br
11891194

11901195
.RS

0 commit comments

Comments
 (0)