Hi Damjan.

>From their docs.
Migrating your code style without ruining git blame

A long-standing argument against moving to automated code formatters like
*Black* is that the migration will clutter up the output of git blame. This
was a valid argument, but since Git version 2.23, Git natively
supports ignoring
revisions in blame
<https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revltrevgt>
with
the --ignore-rev option. You can also pass a file listing the revisions to
ignore using the --ignore-revs-file option. The changes made by the
revision will be ignored when assigning blame. Lines modified by an ignored
revision will be blamed on the previous revision that modified those lines.

So when migrating your project's code style to *Black*, reformat everything
and commit the changes (preferably in one massive commit). Then put the
full 40 characters commit identifier(s) into a file.

# Migrate code style to Black
5b4ab991dede475d393e9d69ec388fd6bd949699

Afterwards, you can pass that file to git blame and see clean and
meaningful blame information.

$ git blame important.py --ignore-revs-file
.git-blame-ignore-revs7a1ae265 (John Smith 2019-04-15 15:55:13 -0400
1) def very_important_function(text, file):abdfd8b0 (Alice Doe
2019-09-23 11:39:32 -0400 2)     text = text.lstrip()7a1ae265 (John
Smith 2019-04-15 15:55:13 -0400 3)     with open(file, "r+") as
f:7a1ae265 (John Smith 2019-04-15 15:55:13 -0400 4)
f.write(formatted)

You can even configure git to automatically ignore revisions listed in a
file on every call to git blame.

On Wed, Dec 2, 2020 at 4:38 AM Damjan Marion <dmar...@me.com> wrote:

>
>
> On 01.12.2020., at 23:55, Paul Vinciguerra <pvi...@vinciconsulting.com>
> wrote:
>
> The question is whether the community wants to upgrade their version of
> git to ignore this change with git blame, in exchange for not having to
> manually lint/fix their files.
>
>
> Can you please explain how new version of git helps here?
>
> —
> Damjan
>
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#18221): https://lists.fd.io/g/vpp-dev/message/18221
Mute This Topic: https://lists.fd.io/mt/78647163/21656
Group Owner: vpp-dev+ow...@lists.fd.io
Unsubscribe: https://lists.fd.io/g/vpp-dev/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-

Reply via email to