From: Junio C Hamano <gitster@pobox.com>
To: Yaroslav Halchenko <debian@onerussian.com>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Documentation: replace - use consistent 'replace reference'
Date: Wed, 27 Apr 2022 14:01:13 -0700 [thread overview]
Message-ID: <xmqq8rrqkzqe.fsf@gitster.g> (raw)
In-Reply-To: <20220427195450.366703-1-debian@onerussian.com> (Yaroslav Halchenko's message of "Wed, 27 Apr 2022 15:54:50 -0400")
Yaroslav Halchenko <debian@onerussian.com> writes:
> As a new user to 'git replace' I found it a little uncertain about what
> "'replace' reference" documentation was talking since there was only
> "replacement" mentioned in the command summary. Decided to make it more
> consistent as 'replace reference' after checking that in a few spots there is a
> use of multi word entries within <>.
>
> Signed-off-by: Yaroslav Halchenko <debian@onerussian.com>
> ---
> Documentation/git-replace.txt | 10 +++++-----
> 1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt
> index f271d758c3..71f98edfe3 100644
> --- a/Documentation/git-replace.txt
> +++ b/Documentation/git-replace.txt
> @@ -8,7 +8,7 @@ git-replace - Create, list, delete refs to replace objects
> SYNOPSIS
> --------
> [verse]
> -'git replace' [-f] <object> <replacement>
> +'git replace' [-f] <object> <replace reference>
If we must use a multi-word, perhaps come up with a dashed form to
make it still a single token, i.e.
'git replace' [-f] <object> <replace-reference>
otherwise it forces people to first think "ah, command reads from a
file (whose name can be 'replace'), and then..." and then backtrack
because the "reference>" part would not be syntactically correct.
You earlier mentioned that you copied the pattern from elsewhere.
These places may have to be updated, too.
> 'git replace' [-f] --edit <object>
> 'git replace' [-f] --graft <commit> [<parent>...]
> 'git replace' [-f] --convert-graft-file
> @@ -17,16 +17,16 @@ SYNOPSIS
>
> DESCRIPTION
> -----------
> -Adds a 'replace' reference in `refs/replace/` namespace.
> +Adds a 'replace reference' in `refs/replace/` namespace.
And this part becomes 'replace-reference', too.
If we must invent and use such a new multi-word jargon, it probably
is a good idea to define it in Documentation/glossary-content.txt
Other than that, looking good.
Thanks.
prev parent reply other threads:[~2022-04-27 21:02 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-27 19:54 [PATCH] Documentation: replace - use consistent 'replace reference' Yaroslav Halchenko
2022-04-27 21:01 ` Junio C Hamano [this message]
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=xmqq8rrqkzqe.fsf@gitster.g \
--to=gitster@pobox.com \
--cc=debian@onerussian.com \
--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.
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).