git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Philip Oakley <philipoakley@iee.org>
To: GitList <git@vger.kernel.org>
Subject: [PATCH v1 1/3] doc: commit: --fixup/--squash can take a commit revision
Date: Sun, 14 Aug 2016 22:46:28 +0100	[thread overview]
Message-ID: <20160814214630.1312-2-philipoakley@iee.org> (raw)
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


  reply	other threads:[~2016-08-14 21:46 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-14 21:46 [PATCH v1 0/3] fixup fixup documenation Philip Oakley
2016-08-14 21:46 ` Philip Oakley [this message]
2016-08-14 22:09   ` [PATCH v1 1/3] doc: commit: --fixup/--squash can take a commit revision Junio C Hamano
2016-08-14 22:45     ` Philip Oakley
2016-08-14 22:55       ` Junio C Hamano
2016-08-14 23:29         ` Philip Oakley
2016-08-16 22:11           ` Philip Oakley
2016-08-14 21:46 ` [PATCH v1 2/3] doc: rebase: fixup! can take an object name Philip Oakley
2016-08-14 22:11   ` Junio C Hamano
2016-08-14 23:00     ` Philip Oakley
2016-08-14 23:02       ` Junio C Hamano
2016-08-14 23:30         ` Philip Oakley
2016-08-14 21:46 ` [PATCH v1 3/3] doc: rebase: clarify fixup! fixup! constraint Philip Oakley
2016-08-14 22:20   ` Junio C Hamano
2016-08-14 23:23     ` Philip Oakley
2016-08-15 15:42       ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160814214630.1312-2-philipoakley@iee.org \
    --to=philipoakley@iee.org \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).