ceos/cagebreak
1
0
Fork 0
mirror of https://cagebreak.project-repo.co/cagebreak.git synced 2026-08-21 13:04:18 +02:00
Code Issues Projects Releases Packages Wiki Activity

Ameliorate README

Browse source
This commit is contained in:
project-repo 2020-05-22 20:24:35 +02:00
commit 68950664e3
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -63,7 +63,7 @@ toward a solution.
### GCC and -fanalyzer
Cagebreak should be buildable with any reasonably new gcc or clang. Consider
Cagebreak should compile with any reasonably new gcc or clang. Consider
a gcc version of at least [10.1](https://gcc.gnu.org/gcc-10/changes.html) if
you want to get the benefit of the brand-new
[-fanalyzer](https://gcc.gnu.org/onlinedocs/gcc/Static-Analyzer-Options.html)
@ -71,8 +71,8 @@ flag. However, this new flag sometimes produces false-postives and we
selectively disable warnings for affected code segments as described below.
Meson is configured to set `CG_HAS_FANALYZE` if `-fanalyzer` is available.
Because we also compile with clang for fuzzing, please use the following
preprocessor statements before
Therefore, to maintain portability, false-positive fanalyzer warnings are to be
disabled using the following syntax:
```
#if CG_HAS_FANALYZE
@ -88,8 +88,6 @@ and after
#endif
```
the offending part of the code iff the warning is a false positive.
### Branching strategy
All features are to be developed on feature branches, named after the feature.
@ -112,7 +110,8 @@ git tag -v version
git push --tags origin master
```
and a log message roughly describing the features added in the commit.
and a log message roughly describing the features added in the commit is
included.
In the past, our git history did not always reflect this scheme.