Skip to content

Commit

Permalink
Merge pull request #4439 from reneme/chore/hide_clang_format_in_blame
Browse files Browse the repository at this point in the history
  • Loading branch information
reneme authored Dec 1, 2024
2 parents 09a7a98 + b4ab5d3 commit 823bcb4
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
9 changes: 9 additions & 0 deletions doc/dev_ref/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,15 @@ needed. If your diff is less than roughly 100 lines, it should probably be a
single commit. Only split commits as needed to help with review/understanding of
the change.

Occasionally we apply and commit updated clang-format rules to the code base. To
avoid cluttering the ``git blame`` output with these intrusive commits, we
maintain a list of them in ``src/configs/git-blame-ignore-revs``. To use it,
either manually add ``--ignore-revs-file=`` to your ``git blame`` command, or
configure it to be used in your local checkout, like so::

git config --local blame.ignoreRevsFile src/configs/git-blame-ignore-revs
git config --local blame.markIgnoredLines true

Python
----------------------------------------

Expand Down
21 changes: 21 additions & 0 deletions src/configs/git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# This file is not picked up automatically. You'll have to either explicitly
# reference it when running git blame using --ignore-revs-file <file> or
# add it to your checkout's local git config like so:
#
# git config --local blame.ignoreRevsFile src/configs/git-blame-ignore-revs
# git config --local blame.markIgnoredLines true

# [clang-format] initial apply to the code base
3f87e1eef7dbfe231d833ffbf06f7a85b070b600

# [clang-format] upgrade v17
fe7a2a1d850ae02934ea04d25fa214c825442535

# [clang-format] Add DEPRECATED macros
697fec3aa0de3b9c1683206c99683a13c115ff9f

# [clang-format] AllowShortFunctionsOnASingleLine
62eeefff1c59f8cc977027d9260c07cf518f6377

# [clang-format] AllowShortBlocksOnASingleLine
de48a2eb6d2d77e104044da84c2fb7df5c08d65a

0 comments on commit 823bcb4

Please sign in to comment.