[git-clang-format] Add some examples to the help text

Differential Revision: https://reviews.llvm.org/D124282
This commit is contained in:
Nico Weber 2022-04-22 13:51:05 -04:00
parent 34b676eb60
commit a45764f2f9
1 changed files with 10 additions and 0 deletions

View File

@ -40,6 +40,16 @@ If zero or one commits are given, run clang-format on all lines that differ
between the working directory and <commit>, which defaults to HEAD. Changes are
only applied to the working directory, or in the stage/index.
Examples:
To format staged changes, i.e everything that's been `git add`ed:
git clang-format
To also format everything touched in the most recent commit:
git clang-format HEAD~1
If you're on a branch off main, to format everything touched on your branch:
git clang-format main
If two commits are given (requires --diff), run clang-format on all lines in the
second <commit> that differ from the first <commit>.