#23739 closed defect (implemented)

improve documentation on how we use gcov

Reported by: catalyst Owned by: catalyst
Priority: Medium Milestone: Tor: 0.3.2.x-final
Component: Core Tor/Tor Version: Tor: 0.2.9.1-alpha
Severity: Normal Keywords: new-developers tor-doc tor-tests-coverage
Cc: Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description

Ticket #16792 (0.2.9.1-alpha) introduced some automation for excluding lines from filtered gcov output. We should document the prefixes it uses to mark excluded lines. There should also be information about how to read the gcov-diff files, which are processed to remove line numbers, among other things. We should also refer to the gcc documentation for gcov at https://gcc.gnu.org/onlinedocs/gcc/Invoking-Gcov.html

Child Tickets

Change History (5)

comment:1 Changed 15 months ago by catalyst

Status: assignedneeds_review

comment:2 Changed 15 months ago by catalyst

Version: Tor: 0.2.9.1-alpha

comment:3 Changed 15 months ago by asn

Status: needs_reviewneeds_revision

Docs look good. I think there is a tiny typo error where it says and line numbers are deleted79. Or is deleted79 something actual?

Other than this, looks good.

comment:4 Changed 15 months ago by catalyst

Status: needs_revisionneeds_review

Thanks! I pushed an update to the merge request fixing that. (I was adjusting fill column settings and one escaped.)

comment:5 Changed 15 months ago by nickm

Resolution: implemented
Status: needs_reviewclosed

Another step forward! Merging in 0.3.2.

Note: See TracTickets for help on using tickets.