Skip to content

Commit 48d99df

Browse files
author
r105366
committed
Add more repo description
1 parent c78abbb commit 48d99df

2 files changed

Lines changed: 28 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ in the container. Or, click on `Open a Remote Window` (at the very left of the
6868
status bar) and choose `Reopen in Container`. Note that, for the first time
6969
only, it may take quite a while for VSCode to create the docker images.
7070

71-
When the DevContainer session is ready, try the following steps.
71+
When the DevContainer session is ready, follow these steps to exercise the
72+
environment's C++ development features.
7273

7374
- Configure the build
7475

@@ -79,8 +80,8 @@ When the DevContainer session is ready, try the following steps.
7980
- Build all and use the test explorer
8081

8182
Choose the `all` build target (in the status bar selector) and build it to
82-
create the library, the test program, and the example programs. Open the test
83-
explorer side pane to view and run the unit tests.
83+
create the library, the unit-test program, and the example programs.
84+
Open the test explorer side pane to view and run the unit tests.
8485

8586
The test explorer has controls to run all the tests or a single test. Or, set
8687
`Start Continuous Run` (at the top of the test explorer) to automatically run
@@ -121,15 +122,22 @@ When the DevContainer session is ready, try the following steps.
121122
Select `Run Build Task` from VSCode's `Terminal` menu to create either a
122123
[full mutation testing report][3], or an analysis for only the branch diffs.
123124

125+
- Look for memory leaks
126+
127+
A custom build task runs the unit-test program under valgrind and logs the
128+
results to a [valgrind report][4].
129+
124130
- Create more reports
125131

126132
The environment has more custom build tasks generating reports from valgrind,
127133
and the compiler's address sanitizer and undefined-behavior sanitizer.
128134

129135

130-
[1]: doc/statistics_coverage_report/coverage_report.html
131-
"HTML code coverage repport for the project unit-test program"
136+
[1]: https://github.com/ian-fisher-developer/development-tools/blob/main/doc/statistics_coverage_report/coverage_report.html
137+
"HTML code coverage report for the project unit-test program"
132138
[2]: https://en.wikipedia.org/wiki/Mutation_testing
133139
"Wikipedia description of mutation testing"
134140
[3]: doc/statistics_test_no-diff-filter.txt
135141
"Full mutation testing report for the project unit-test program"
142+
[4]: doc/statistics_test_valgrind.txt
143+
"Valgrind report for the project unit-test program"

doc/statistics_test_valgrind.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
==15099== Memcheck, a memory error detector
2+
==15099== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
3+
==15099== Using Valgrind-3.18.1 and LibVEX; rerun with -h for copyright info
4+
==15099== Command: ./statistics_test --gtest_filter=*.*
5+
==15099== Parent PID: 15097
6+
==15099==
7+
==15099==
8+
==15099== HEAP SUMMARY:
9+
==15099== in use at exit: 0 bytes in 0 blocks
10+
==15099== total heap usage: 612 allocs, 612 frees, 169,585 bytes allocated
11+
==15099==
12+
==15099== All heap blocks were freed -- no leaks are possible
13+
==15099==
14+
==15099== For lists of detected and suppressed errors, rerun with: -s
15+
==15099== ERROR SUMMARY: 0 errors from 0 contexts (suppressed: 0 from 0)

0 commit comments

Comments
 (0)