Commit cd4feb32 authored by Albert Astals Cid's avatar Albert Astals Cid
Browse files

Add .git-blame-ignore-revs and some instructions for clang-format

parent 9d9e20bd
Pipeline #171479 failed with stages
in 9 minutes and 51 seconds
# _clang_format added
814fbda28cc8a37fed3134c2db8da28f86fb5ee0
...@@ -18,4 +18,21 @@ Poppler has three main channels of contact: ...@@ -18,4 +18,21 @@ Poppler has three main channels of contact:
* The #poppler channel at the IRC freenode network * The #poppler channel at the IRC freenode network
Do not hesitate to drop by talk to people there. Do not hesitate to drop by talk to people there.
clang-format
------------
We introduced clang-format mandatory usage in July 2020.
If you want git blame to ignore the revision in which we did the mass change you can do
git config blame.ignoreRevsFile .git-blame-ignore-revs
on your clone
To get the clang-format warnings locally instead at CI time we recommend you
to copy the hooks/pre-commit to your .git
cp hooks/pre-commit .git/hooks/
We are using clang-format 10 on CI. Unfortunately clang-format is not totally
compatible with older versions of itself. If CI gives you trouble but your local
clang-format disagrees, just apply the changes suggested by CI and then commit
with the --no-verify flag. If you get stuck, don't hesitate to ask the reviewer
to help and they will reformat your commits :)
And keep hacking on poppler! And keep hacking on poppler!
#!/usr/bin/env bash
readonly output=$(git clang-format -v --diff)
if [[ "$output" == *"no modified files to format"* ]]; then exit 0; fi
if [[ "$output" == *"clang-format did not modify any files"* ]]; then exit 0; fi
echo "ERROR: you need to run git clang-format on your commit"
echo " git clang-format -f is potentially what you want"
exit 1
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment