Skip to content

Commit bee8ae7

Browse files
committed
man: Add clarification regarding file patterns
Add a note the the lcov and geninfo man pages to clarify that patterns used to match source code file names must be specified to match the absolute path of such files. Signed-off-by: Peter Oberparleiter <[email protected]>
1 parent 1508b88 commit bee8ae7

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

man/geninfo.1

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,10 @@ command line switches. The
307307
will be interpreted as shell wildcard patterns (note that they may need to be
308308
escaped accordingly to prevent the shell from expanding them first).
309309

310+
Note: The pattern must be specified to match the
311+
.B absolute
312+
path of each source file.
313+
310314
Can be combined with the
311315
.B --include
312316
command line switch. If a given file matches both the include pattern and the
@@ -366,6 +370,10 @@ command line switches. The
366370
.I patterns
367371
will be interpreted as shell wildcard patterns (note that they may need to be
368372
escaped accordingly to prevent the shell from expanding them first).
373+
374+
Note: The pattern must be specified to match the
375+
.B absolute
376+
path of each source file.
369377
.RE
370378

371379
.B \-\-ignore\-errors

man/lcov.1

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,10 @@ command line switches. The
497497
will be interpreted as shell wildcard patterns (note that they may need to be
498498
escaped accordingly to prevent the shell from expanding them first).
499499

500+
Note: The pattern must be specified to match the
501+
.B absolute
502+
path of each source file.
503+
500504
Can be combined with the
501505
.B --include
502506
command line switch. If a given file matches both the include pattern and the
@@ -540,6 +544,10 @@ Every file entry in
540544
.I tracefile
541545
which matches at least one of those patterns will be extracted.
542546

547+
Note: The pattern must be specified to match the
548+
.B absolute
549+
path of each source file.
550+
543551
The result of the extract operation will be written to stdout or the tracefile
544552
specified with \-o.
545553

@@ -598,6 +606,10 @@ command line switches. The
598606
.I patterns
599607
will be interpreted as shell wildcard patterns (note that they may need to be
600608
escaped accordingly to prevent the shell from expanding them first).
609+
610+
Note: The pattern must be specified to match the
611+
.B absolute
612+
path of each source file.
601613
.RE
602614

603615
.B \-\-ignore\-errors
@@ -799,6 +811,10 @@ Every file entry in
799811
.I tracefile
800812
which matches at least one of those patterns will be removed.
801813

814+
Note: The pattern must be specified to match the
815+
.B absolute
816+
path of each source file.
817+
802818
The result of the remove operation will be written to stdout or the tracefile
803819
specified with \-o.
804820

0 commit comments

Comments
 (0)