[PATCH v1 1/3] doc: commit: --fixup/--squash can take a commit revision
- From
Philip Oakley <philipoakley@iee.org>
- Date
- Aug 14, 2016, 21:46 UTC
- Message-ID
- <20160814214630.1312-2-philipoakley@iee.org>
- In-Reply-To
- <20160814214630.1312-1-philipoakley@iee.org>
Be clearer that the --fixup/--squash options can take any of the gitrevisions methods of specifying a commit, not just a 'hash'.
Signed-off-by: Philip Oakley <philipoakley@iee.org> --- v1 It's not immediately obvious what different forms the <commit> option can take. Spell out, and refer to the git revisions guide, that any of the revision methods will work.
On a side note, if one looks at the glossary, a <commit> links to <commit object> which links to <object> (and only tangentially "about" revisions) which then says "uniquely identified by the SHA-1", so it is easy to think one should use the sha1 here.
I only discovered this misunderstanding while following up other parts of this series! --- Documentation/git-commit.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index e704953..3600929 100644 --- a/Documentation/git-commit.txt +++ b/Documentation/git-commit.txt @@ -81,15 +81,15 @@ OPTIONS --fixup=<commit>:: Construct a commit message for use with `rebase --autosquash`. The commit message will be the subject line from the specified - commit with a prefix of "fixup! ". See linkgit:git-rebase[1] - for details. + commit revision with a prefix of "fixup! ". See linkgit:git-rebase[1] + and linkgit:gitrevisions[7] for details. --squash=<commit>:: Construct a commit message for use with `rebase --autosquash`. The commit message subject line is taken from the specified - commit with a prefix of "squash! ". Can be used with additional + commit revision with a prefix of "squash! ". Can be used with additional commit message options (`-m`/`-c`/`-C`/`-F`). See - linkgit:git-rebase[1] for details. + linkgit:git-rebase[1] and linkgit:gitrevisions[7] for details. --reset-author:: When used with -C/-c/--amend options, or when committing after a
-- 2.9.0.windows.1