Skip to content

Add new documentation for homebrew tap #6817

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 2 commits into from
Apr 26, 2022

Conversation

NlightNFotis
Copy link
Contributor

@NlightNFotis NlightNFotis commented Apr 20, 2022

This PR adds new documentation for both users and developers of the CBMC tap.

  • 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 Apr 20, 2022

Codecov Report

Merging #6817 (cd4139b) into develop (7f0f486) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head cd4139b differs from pull request most recent head 761f7fb. Consider uploading reports for the commit 761f7fb to get more accurate results

@@            Coverage Diff            @@
##           develop    #6817    +/-   ##
=========================================
  Coverage    77.00%   77.01%            
=========================================
  Files         1594     1594            
  Lines       184359   184954   +595     
=========================================
+ Hits        141966   142438   +472     
- Misses       42393    42516   +123     
Impacted Files Coverage Δ
...oto-instrument/contracts/instrument_spec_assigns.h 94.73% <ø> (ø)
src/goto-instrument/contracts/contracts.cpp 94.48% <100.00%> (+0.59%) ⬆️
...o-instrument/contracts/instrument_spec_assigns.cpp 97.42% <100.00%> (+0.28%) ⬆️
src/goto-instrument/contracts/utils.h 83.01% <0.00%> (-16.99%) ⬇️
src/solvers/flattening/boolbv.cpp 80.33% <0.00%> (-0.06%) ⬇️
src/util/std_expr.h 93.18% <0.00%> (ø)
src/util/replace_symbol.h 100.00% <0.00%> (ø)
src/util/replace_symbol.cpp 88.29% <0.00%> (+0.34%) ⬆️
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac6b8a9...761f7fb. Read the comment docs.

@TGWDB
Copy link
Contributor

TGWDB commented Apr 21, 2022

Note that this partially fixes #6750

Copy link
Contributor

@TGWDB TGWDB left a comment

Choose a reason for hiding this comment

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

Looks good.

@NlightNFotis NlightNFotis force-pushed the homebrew_tap branch 2 times, most recently from 49b63af to eeec637 Compare April 22, 2022 10:37
@NlightNFotis NlightNFotis marked this pull request as ready for review April 22, 2022 10:38
@NlightNFotis NlightNFotis force-pushed the homebrew_tap branch 2 times, most recently from 6573bef to b6614ff Compare April 22, 2022 14:28

## Developer instructions

1. First of all, you need to create a new tap locally:
Copy link
Contributor

Choose a reason for hiding this comment

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

Under what circumstances do we need to create a tap locally? Is this part of creating an entirely separate tap on github, or modifying the tap that already exists to add new versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah that was there just for documentation purposes.

Most likely you won't need to do that

It's a one off for setting up a new tap, and as we already have one, (it's highly likely) no one's going to need to do that again.

@NlightNFotis NlightNFotis merged commit a5ce4e5 into diffblue:develop Apr 26, 2022
@NlightNFotis NlightNFotis deleted the homebrew_tap branch April 26, 2022 09:34
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.

4 participants