Make the instructions slightly easier to read

This commit is contained in:
szb512 2020-07-09 09:23:32 -04:00 committed by Zbigniew Jędrzejewski-Szmek
parent 8ba6c15a82
commit 5b72b34708

View file

@ -1,18 +1,18 @@
# This configuration file can be used to auto-format the code base. # This configuration file can be used to auto-format the code base.
# Not all guidelines specified in CODING_STYLE are followed, so the # Not all guidelines specified in CODING_STYLE are followed, so the
# result MUST NOT be committed indiscriminately, but each automated # result MUST NOT be committed indiscriminately, but each automated
# change should be reviewed and only the appropriate ones commited. # change should be reviewed and only the appropriate ones can be commited.
# #
# The easiest way to apply the formatting to your changes ONLY, # The easiest way to apply the formatting to your changes ONLY,
# is to use the git-clang-format script (usually installed with clang-format). # is to use the git-clang-format script (usually installed with clang-format).
# #
# - Fixup formatting before committing # - Fix up formatting before committing
# 1. Edit and stage your files. # 1. Edit and stage your files.
# 2. Run `git clang-format`. # 2. Run `git clang-format`.
# 3. Verify + correct + (un)stage changes. # 3. Verify + correct + (un)stage changes.
# 4. Commit. # 4. Commit.
# #
# - Fixup formatting after committing # - Fix up formatting after committing
# 1. Commit your changes. # 1. Commit your changes.
# 2. Run `git clang-format HEAD~` - Refer the commit *before* your changes here. # 2. Run `git clang-format HEAD~` - Refer the commit *before* your changes here.
# 3. Verify + correct changes, `git difftool -d` can help here. # 3. Verify + correct changes, `git difftool -d` can help here.