Skip to content

Consistently name README files and clean up #7347

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 3 commits into from
Nov 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/architectural/compilation-and-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,12 @@ CI, should succeed), `THOROUGH` (takes too long to be run in CI, should
succeed), `FUTURE` (will succeed when a planned feature is added) or
`KNOWNBUG` (will succeed when a bug is fixed).

Test descriptions may also include a number of tags. `test.pl -I<tag>` will only
run tests with a particular `<tag>`, and `test.pl -X<tag>` will run all tests
except for those with a particular `<tag>`. See
[regression/README.md](https://github.com/diffblue/cbmc/blob/develop/regression/README.md)
for the current set of tags and their intended use.

\subsubsection compilation-and-development-subsubsection-running-regression-tests-with-make Running regression tests with make

If you have compiled using `make` then you can run the regression tests
Expand Down
13 changes: 3 additions & 10 deletions regression/readme.md → regression/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,6 @@ This folder contains the CProver regression test-suite.

- `winbug`:
These tests are currently known to be failing on Windows,
but passing on other platforms.
The reason for this is not known, and it's currently being investigated.
This was discovered during work done to port CI from [Travis]
and [AWS CodeBuild] to [GitHub Actions].
Worth noting that those tests were not being run on Windows before.


[AWS CodeBuild]: https://aws.amazon.com/codebuild/
[GitHub Actions]: https://github.com/features/actions
[Travis]: https://travis-ci.com/
but passing on other platforms. https://github.com/diffblue/cbmc/pull/5572
will address one part thereof; the remaining ones are C++ tests that fail on
both Windows and MacOS for our lack of C++-11 support.
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,7 @@ test.c
--malloc-may-fail --malloc-fail-null
^EXIT=10$
^SIGNAL=0$
\[main.assertion.1\] line 7 assertion array != .*: FAILURE
\[main.assertion.1\] line 7 assertion array != NULL: FAILURE
--
--
Compiling a file with goto-cc should not affect how --malloc-may-fail behaves
Regex in the assertion because on travis for some reason the preprocessor seems to run
before cbmc.
File renamed without changes.