Skip to content
Snippets Groups Projects
Commit 8372d612 authored by Oliver Sander's avatar Oliver Sander
Browse files

Document the new CI formatting check in README.md

parent cc4acb9c
Branches
No related tags found
1 merge request!208Add a CI job that runs uncrustify and checks for modifications
Pipeline #69330 passed
# dune-fufem
Finite element assemblers based on the bases from dune-functions.
## Automatic code formatting
The GitLab CI system of this module (in the file `.gitlab-ci.yml`) includes a job
that checks for proper code formatting. The CI system
uses the tool [uncrustify](https://github.com/uncrustify/uncrustify) to enforce the rules, guided by
the configuration file `dune-uncrustify.org` in the `dune-fufem` module source directory.
CI testing of the code formatting means that any merge request will fail CI
testing if it introduces code changes that violate the formatting rules.
To check locally whether code changes that you have made comply with the rules,
run
```
uncrustify -l CPP -c dune-uncrustify.cfg --no-backup `find -name "*.cc" -o -name "*.hh"`
```
in your source directory. If this does not modify the code, then your formatting
is correct.
When starting to use `uncrustify` to enforce proper code formatting, one large commit
had to be made that applied large amounts of white-space changes to pretty much
every source file. If you are bothered by this when using `git blame`, you can
tell `git` to ignore this particular commit by saying
```
git blame --ignore-revs-file=.git-blame-ignore-revs <file>
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment