Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
dune-fufem
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
fufem
dune-fufem
Commits
8372d612
Commit
8372d612
authored
1 year ago
by
Oliver Sander
Browse files
Options
Downloads
Patches
Plain Diff
Document the new CI formatting check in README.md
parent
cc4acb9c
Branches
Branches containing commit
No related tags found
1 merge request
!208
Add a CI job that runs uncrustify and checks for modifications
Pipeline
#69330
passed
1 year ago
Stage: .pre
Stage: test
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+29
-0
29 additions, 0 deletions
README.md
with
29 additions
and
0 deletions
README.md
0 → 100644
+
29
−
0
View file @
8372d612
# 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>
```
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment