-
Notifications
You must be signed in to change notification settings - Fork 13
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.
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
doc: introduce code coverage section #446
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Paolo Valerio <[email protected]>
I snuck the vagrant workaround removal into the series as this should be fixed now and a separate PR was not really needed. |
2.4.3 fixes the dependency issue. Let's simply use that. Signed-off-by: Paolo Valerio <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few comments:
- I tried using it and it seems
cargo-llvm-cov
needs to be installed as well as the rustupllvm-tools-preview
component. - Can you use an example for
toolchain
so users know what to look for? - The
CARGO_OPTS
use should be in its own paragraph, but not in the default example. - Since the html output is optional, maybe let's not use it in the default example but alongside the last paragraph. Eg. "for redability you can ...".
right, these are needed.
this could be whatever it is installed via rustup, so could be any version (maybe names can be assigned).
ok, let's move optional stuff in their paragraph. |
Could be any version, I think the explanation is good in this regards. I just think using whatever version as an example would gives an idea what is expected. Eg. "with a local tool chain being ... this would look like ...". |
as per title