Skip to content
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

Jump to bottom

[docs] Add instructions for lcov report generation #11680

Merged
merged 1 commit into from Nov 15, 2017
Merged

[docs] Add instructions for lcov report generation #11680

merged 1 commit into from Nov 15, 2017

Conversation

jamesob
Copy link
Member

@jamesob jamesob commented Nov 14, 2017

After rediscovering the lcov report generation recipe one too many times, it seemed prudent to write some doc.

@fanquake fanquake added the Docs label Nov 14, 2017
promag
promag reviewed Nov 14, 2017
View reviewed changes
Copy link
Member

@promag promag left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Concept ACK.

doc/developer-notes.md Outdated
@@ -182,6 +182,23 @@ $ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
$ valgrind -v --leak-check=full src/bitcoind -printtoconsole
```

**compiling for test coverage**

Lcov can be used to generate a test coverage report based upon `make check`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Upper case LCOV.

doc/developer-notes.md Outdated
**compiling for test coverage**

Lcov can be used to generate a test coverage report based upon `make check`
execution. To enable lcov usage during test runs:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above.

doc/developer-notes.md Outdated
execution. To enable lcov usage during test runs:

```shell
# Ensure `lcov` is installed on your system; e.g. on Debian this would be:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove comment? Just say lcov must be available/installed above.

doc/developer-notes.md Outdated
# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`.
```


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove 2nd empty line.

@maflcko
Copy link
Member

maflcko commented Nov 14, 2017

utACK 1e9b9923b532219dc8002791b3fda0616ae5806d

@fanquake
Copy link
Member

utACK after nits addressed

@jamesob
Copy link
Member Author

jamesob commented Nov 14, 2017

@promag feedback incorporated; thanks.

@fanquake
Copy link
Member

utACK 5ff01c2

@jonasschnelli
Copy link
Contributor

Thanks.
utACK 5ff01c2

@jonasschnelli jonasschnelli merged commit 5ff01c2 into bitcoin:master Nov 15, 2017
jonasschnelli added a commit that referenced this pull request Nov 15, 2017
@jonasschnelli
Merge #11680: [docs] Add instructions for lcov report generation
4db82b7 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
promag
promag reviewed Nov 15, 2017
View reviewed changes
Copy link
Member

@promag promag left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK.

doc/developer-notes.md
make
make cov

# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit, could be out of code block.

@Sjors Sjors mentioned this pull request Nov 22, 2017
Merged
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 17, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
28cc559 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 22, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
4221199 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 22, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
bda1780 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 29, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
19b7420 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 29, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
93edb65 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Jan 29, 2020
@jonasschnelli @PastaPastaPasta
Merge bitcoin#11680: [docs] Add instructions for lcov report generation
5bbbce3 
5ff01c2 [docs] Add instructions for lcov coverage report generation (James O'Beirne)

Pull request description:

  After rediscovering the `lcov` report generation recipe one too many times, it seemed prudent to write some doc.

Tree-SHA512: 20e1b5f51ecd39e14bd67986a2c1578fb7da03a50625366eaca35b201db66aef99cd4a5456df3aaca5d2d66b18ed7d2e8eb8f3bd9c7aaf9af48164d9bac38931
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@promag promag promag left review comments

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@jamesob @maflcko @fanquake @jonasschnelli @promag