@@ -44,6 +44,7 @@ Further README contents
44
44
5. An example of how to access coverage data for a user space program
45
45
6. New features in lcov 2.0
46
46
7. Questions and Comments
47
+ 8. Filing a new issue
47
48
48
49
49
50
@@ -100,6 +101,7 @@ To run the LCOV regression test suite on your installation:
100
101
If desired, you can collect coverage data for the LCOV module by setting
101
102
the COVERAGE makefile variable.
102
103
Note that the Devel::Cover package must be installed if COVERAGE is enabled
104
+ or if you want to use the perl2lcov utility.
103
105
To view the collected coverage information, point your browser to
104
106
.../cover_db/coverage.html after running the tests.
105
107
@@ -446,3 +448,35 @@ In case of further questions, feel free to open a new issue using the issue
446
448
tracker on the LCOV code repository site at:
447
449
448
450
https://github.com/linux-test-project/lcov
451
+
452
+
453
+ 8. Filing a new issue
454
+ ---------------------
455
+ Before filing a new issue - and if you are using an LCOV release (as opposed
456
+ to using a clone of the github repo) - please verify whether the issue is
457
+ still present in the LCOV master version. See section 2, above for
458
+ directions on how to clone and install the most up-to-date LCOV version.
459
+
460
+ If possible, please include a testcase which illustrates the problem
461
+ when you file an issue.
462
+ Please describe your environment (platform, compiler, perl, and python
463
+ versions, etc.). Please include a detailed description of the issue:
464
+ what you were trying to do (your goal - not the mechanics of your
465
+ procedure), what you did (the mechanics of your procedure), the result
466
+ you wanted to see vs. what actually happened.
467
+ Depending on the issue, your testcase may need to include source code and
468
+ compile/link command lines, directions for how to run your example, the
469
+ command lines used to capture and generate your lcov reports, etc.
470
+ In other cases, the captured '.info' files may be sufficient to reproduce
471
+ the issue.
472
+ When in doubt: more is better than less.
473
+
474
+ If you cannot include a testcase - e.g., because you feel that it is
475
+ senstitive or proprietary - then your detailed description is even more
476
+ important.
477
+ Note that, without an example, it may be difficult or impossible to
478
+ diagnose or fix the problem.
479
+
480
+ Bear in mind that you are asking for help from volunteers. Your
481
+ priority might not be their priority. Civility, consideration and politeness
482
+ go a long way.
0 commit comments