diff options
author | Jean-Noël Avila <jn.avila@free.fr> | 2023-12-25 21:21:26 +0000 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2023-12-26 11:06:55 -0800 |
commit | 2162f9f6f86df4f49c3a716b5beb3952104ea8b8 (patch) | |
tree | 9f0fec3c23e0ef98bbb46ec8ceec200355330c89 /Documentation/git-filter-branch.txt | |
parent | 055bb6e9969085777b7fab83e3fee0017654f134 (diff) | |
download | git-2162f9f6f86df4f49c3a716b5beb3952104ea8b8.tar.gz |
doc: enforce dashes in placeholders
The CodingGuidelines documents stipulates that multi-word placeholders
are to be separated by dashes, not underscores nor spaces.
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-filter-branch.txt')
-rw-r--r-- | Documentation/git-filter-branch.txt | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt index 62e482a95e..5a4f853785 100644 --- a/Documentation/git-filter-branch.txt +++ b/Documentation/git-filter-branch.txt @@ -14,7 +14,7 @@ SYNOPSIS [--msg-filter <command>] [--commit-filter <command>] [--tag-name-filter <command>] [--prune-empty] [--original <namespace>] [-d <directory>] [-f | --force] - [--state-branch <branch>] [--] [<rev-list options>...] + [--state-branch <branch>] [--] [<rev-list-options>...] WARNING ------- @@ -32,7 +32,7 @@ listed there as reasonably possible. DESCRIPTION ----------- Lets you rewrite Git revision history by rewriting the branches mentioned -in the <rev-list options>, applying custom filters on each revision. +in the <rev-list-options>, applying custom filters on each revision. Those filters can modify each tree (e.g. removing a file or running a perl rewrite on all files) or information about each commit. Otherwise, all information (including original commit times or merge @@ -624,7 +624,7 @@ with: real backup; it dereferences tags first.) ** Running git-filter-branch with either --tags or --all in your - <rev-list options>. In order to retain annotated tags as + <rev-list-options>. In order to retain annotated tags as annotated, you must use --tag-name-filter (and must not have restored from refs/original/ in a previously botched rewrite). |