From: "Philip Oakley" <philipoakley@iee.org>
To: "Philip Oakley" <philipoakley@iee.org>,
"Junio C Hamano" <gitster@pobox.com>
Cc: "GitList" <git@vger.kernel.org>
Subject: Re: [PATCH v1 1/3] doc: commit: --fixup/--squash can take a commit revision
Date: Tue, 16 Aug 2016 23:11:05 +0100 [thread overview]
Message-ID: <CAE3EC6B78644AA8BD07FED08AF44EAE@PhilipOakley> (raw)
In-Reply-To: F18C2CCC29E5470CA1374D9718B2A3E6@PhilipOakley
From: "Philip Oakley" <philipoakley@iee.org>
> From: "Junio C Hamano" <gitster@pobox.com>
>> "Philip Oakley" <philipoakley@iee.org> writes:
>>
>>>> I think the
>>>> use of "commit" in an angle-bracket-pair in the label for the
>>>> section, i.e. "--fixup=<commit>", has been considered to be clear
>>>> enough to tell that you can use usual extended SHA-1 syntax to
>>>> specify the commit you want to talk about,
>>>
>>> I certainly hadn't picked up on that ability to use the extended sha1
>>> syntax (specifying revisions...) here.
>>
>> By "has been considered", I meant that the documentation text is
>> still open for improvement. I just didn't find rewording "commit"
>> with "commit revision" is that improvement we need there.
>>
>> Perhaps we need to have somewhere central a section that explains
>> various notations used in the documentation set. I think it is safe
>> to say something like "unless otherwise qualified, <commit> (or any
>> object type in an angle-bracket-pair) is used as a placeholder to
>> take any acceptable way to spell object names (cf. gitrevisions for
>> details)" these days [*1*].
>
> True. I'm cautious that we may accidentally still hide it in another
> document that the user doesn't see when reading "this" (or any other) man
> page.
>
> Your sentence is short enough to be added to those few key pages that
> users refer to to get them started in the right direction.
>
>> *1* In ancient days I think some plumbing commands only took 40-hex
>> object names, but as far as I know they've all been updated.
>> --
I'll take the patch series away and have a rework over the coming week or
so.
Philip
next prev parent reply other threads:[~2016-08-16 22:11 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 ` [PATCH v1 1/3] doc: commit: --fixup/--squash can take a commit revision Philip Oakley
2016-08-14 22:09 ` 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 [this message]
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CAE3EC6B78644AA8BD07FED08AF44EAE@PhilipOakley \
--to=philipoakley@iee.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).