diff options
| author |  Alex Chernyakhovsky <achernya@google.com> | 2022-02-14 15:49:38 -0500 |
|---|---|---|
| committer |  Alex Chernyakhovsky <achernya@mit.edu> | 2022-05-30 19:38:10 -0400 |
| commit | 1f27c532ac9603e8d05f6066b3e83d8d141bb545 (patch) | |
| tree | a40c2ea86078f395c05cf89e76cf445f8117fac5 /README.md | |
| parent | 16c4ff84f9bd931e7d83a88e7ddf3c06619a0917 (diff) | |
Add code coverage instructions to README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -144,6 +144,22 @@ Mosh has a Perl dependency that is only required for client use. For some platforms, it may make sense to have separate mosh-server and mosh-client packages to allow mosh-server usage without Perl. +Notes for developers +-------------------- + +Mosh supports producing code coverage reports by tests, but this feature is +disabled by default. To enable it, make sure `lcov` is installed on your +system. Then, configure and run tests: + +``` +$ ./configure --enable-code-coverage +$ make check-code-coverage +``` + +This will run all tests and produce a coverage report in HTML form that can be +opened with your favorite browser. Ideally, newly added code should strive for +90% (or better) incremental test coverage. + More info --------- |