git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Yaroslav Halchenko <debian@onerussian.com>
To: git@vger.kernel.org
Cc: Yaroslav Halchenko <debian@onerussian.com>
Subject: [PATCH] Documentation: replace - use consistent 'replace reference'
Date: Wed, 27 Apr 2022 15:54:50 -0400	[thread overview]
Message-ID: <20220427195450.366703-1-debian@onerussian.com> (raw)

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>
 '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.
 
-The name of the 'replace' reference is the SHA-1 of the object that is
-replaced. The content of the 'replace' reference is the SHA-1 of the
+The name of the 'replace reference' is the SHA-1 of the object that is
+replaced. The content of the 'replace reference' is the SHA-1 of the
 replacement object.
 
 The replaced object and the replacement object must be of the same type.
 This restriction can be bypassed using `-f`.
 
-Unless `-f` is given, the 'replace' reference must not yet exist.
+Unless `-f` is given, the 'replace reference' must not yet exist.
 
 There is no other restriction on the replaced and replacement objects.
 Merge commits can be replaced by non-merge commits and vice versa.
-- 
2.35.1


             reply	other threads:[~2022-04-27 20:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-04-27 19:54 Yaroslav Halchenko [this message]
2022-04-27 21:01 ` [PATCH] Documentation: replace - use consistent 'replace reference' 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=20220427195450.366703-1-debian@onerussian.com \
    --to=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).