Skip to content
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

new help formatter and console API #7141

Merged
merged 1 commit into from
Oct 24, 2022
Merged

new help formatter and console API #7141

merged 1 commit into from
Oct 24, 2022

Conversation

kroening
Copy link
Member

This commit adds a new help formatter, which supports a limited form of markup to visually distinguish different syntactic elements of the command line arguments.

Rendering of the syntax highlighting is done via a new console API.

  • 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.
  • 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 19, 2022

Codecov Report

Base: 78.01% // Head: 78.03% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (7508bae) compared to base (ddf0fd2).
Patch has no changes to coverable lines.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #7141      +/-   ##
===========================================
+ Coverage    78.01%   78.03%   +0.01%     
===========================================
  Files         1625     1624       -1     
  Lines       187407   187362      -45     
===========================================
  Hits        146201   146201              
+ Misses       41206    41161      -45     
Impacted Files Coverage Δ
src/cprover/cprover_parse_options.cpp 56.58% <ø> (ø)
src/cprover/generalization.cpp 84.21% <ø> (ø)
src/cprover/inductiveness.cpp 78.35% <ø> (ø)
src/cprover/propagate.cpp 74.28% <ø> (ø)
src/cprover/report_properties.cpp 88.46% <ø> (ø)
src/cprover/report_traces.cpp 89.74% <ø> (ø)
src/cprover/solver.cpp 92.00% <ø> (ø)
src/cprover/solver_progress.cpp 60.00% <ø> (ø)
src/util/console.cpp 29.76% <ø> (ø)
src/util/console.h 66.66% <ø> (ø)
... and 3 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 assigned kroening and unassigned tautschnig Oct 24, 2022
@peterschrammel
Copy link
Member

Since there is progress on this front now, I guess I can close #4404 ?

@tautschnig
Copy link
Collaborator

Since there is progress on this front now, I guess I can close #4404 ?

I had completely forgotten about that one. I'd like to think that #4404 will still yield further improvement? All that we are getting here for now is more beautiful output on the terminal, but nothing machine-readable just yet.

@peterschrammel
Copy link
Member

but nothing machine-readable just yet

You're right. I'll keep it open for reference.

Comment on lines 20 to 21
#include "axioms.h"
#include "bv_pointers_wide.h"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not a big deal, but this is surprising?!

This commit adds a new help formatter, which supports a limited form of
markup to visually distinguish different syntactic elements of the command
line arguments.

Rendering of the syntax highlighting is done via a new console API.
@kroening kroening merged commit a1ac0f6 into develop Oct 24, 2022
@kroening kroening deleted the help-formatter branch October 24, 2022 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants