Skip to content

Update CBMC man page #6937

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
merged 1 commit into from
Sep 28, 2022
Merged

Conversation

tautschnig
Copy link
Collaborator

With command-line help being complete, help2man was used to create an
updated list of options for CBMC's man page. Moving forward, automated
checks for man-page completeness will be put in place so that future
changes to the command line will have to be reflected as part of the
changing commit.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • 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).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

@codecov
Copy link

codecov bot commented Jun 16, 2022

Codecov Report

Base: 77.88% // Head: 77.88% // No change to project coverage 👍

Coverage data is based on head (2d183e5) compared to base (c764c1d).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #6937   +/-   ##
========================================
  Coverage    77.88%   77.88%           
========================================
  Files         1576     1576           
  Lines       181856   181856           
========================================
  Hits        141645   141645           
  Misses       40211    40211           
Impacted Files Coverage Δ
src/util/expr.h 97.02% <ø> (ø)

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 force-pushed the cleanup/cbmc-man-page branch 2 times, most recently from 3e6f179 to 413792c Compare June 23, 2022 15:02
@tautschnig tautschnig force-pushed the cleanup/cbmc-man-page branch from 413792c to 9f37c22 Compare June 29, 2022 11:38
@tautschnig tautschnig mentioned this pull request Jul 12, 2022
7 tasks
@tautschnig tautschnig force-pushed the cleanup/cbmc-man-page branch from 9f37c22 to 7e51dff Compare August 12, 2022 08:42
With command-line help being complete, help2man was used to create an
updated list of options for CBMC's man page. Moving forward, automated
checks for man-page completeness will be put in place so that future
changes to the command line will have to be reflected as part of the
changing commit.
@tautschnig tautschnig force-pushed the cleanup/cbmc-man-page branch from 7e51dff to 2d183e5 Compare September 28, 2022 07:56
.\" groff -man -Tascii cbmc.1
.\"
.TH CBMC 1 "JUNE 2014" "cbmc-4.7" "User Manual"
.TH CBMC "1" "June 2022" "cbmc-5.59.0" "User Commands"
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there some way to get the version here to be integrated with the one in src/config.inc? Maybe some sed magic before a new version? 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If someone can educate me on how to accomplish this in CMake then I'd happily add this. I'd hope that https://cmake.org/cmake/help/latest/command/install.html#script could somehow work, but I'm not entirely sure when this is really run. @thomasspriggs perhaps?

@kroening kroening merged commit 9d317b3 into diffblue:develop Sep 28, 2022
@tautschnig tautschnig deleted the cleanup/cbmc-man-page branch September 29, 2022 09:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants