Skip to content

Check completeness of man pages #7169

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

Merged

Conversation

tautschnig
Copy link
Collaborator

Extend the checks of --help output to also cover man pages.

  • Each commit message has a non-empty body, explaining why the change was made.
  • n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • n/a My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • n/a White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@codecov
Copy link

codecov bot commented Sep 30, 2022

Codecov Report

Base: 77.82% // Head: 77.89% // Increases project coverage by +0.07% 🎉

Coverage data is based on head (e01f9df) compared to base (2a08d59).
Patch coverage: 91.45% of modified lines in pull request are covered.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #7169      +/-   ##
===========================================
+ Coverage    77.82%   77.89%   +0.07%     
===========================================
  Files         1578     1616      +38     
  Lines       182242   186701    +4459     
===========================================
+ Hits        141824   145437    +3613     
- Misses       40418    41264     +846     
Impacted Files Coverage Δ
src/goto-instrument/contracts/contracts.cpp 95.11% <90.47%> (-1.18%) ⬇️
src/assembler/remove_asm.cpp 78.66% <93.10%> (+27.28%) ⬆️
src/goto-instrument/contracts/contracts.h 100.00% <100.00%> (ø)
src/goto-instrument/nondet_static.cpp 96.92% <100.00%> (ø)
src/goto-programs/string_instrumentation.cpp 25.11% <100.00%> (ø)
src/solvers/smt2/smt2_conv.h 84.61% <0.00%> (-15.39%) ⬇️
src/goto-programs/goto_program.h 90.19% <0.00%> (-0.51%) ⬇️
src/cprover/bv_pointers_wide.cpp 57.77% <0.00%> (ø)
src/cprover/address_taken.cpp 100.00% <0.00%> (ø)
src/cprover/cprover_parse_options.cpp 56.58% <0.00%> (ø)
... and 47 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@tautschnig tautschnig marked this pull request as draft October 3, 2022 11:19
This option was added in 948994a, but the man page wasn't updated at
the time.
Extend the checks of --help output to also cover man pages.
@tautschnig tautschnig force-pushed the feature/complete-man-pages branch from 25da5ca to e01f9df Compare October 4, 2022 10:08
@tautschnig tautschnig marked this pull request as ready for review October 4, 2022 10:08
@kroening kroening removed their assignment Oct 4, 2022
@NlightNFotis NlightNFotis merged commit 535713d into diffblue:develop Oct 4, 2022
@tautschnig tautschnig deleted the feature/complete-man-pages branch October 4, 2022 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants