git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: "brian m. carlson" <sandals@crustytoothpaste.net>
To: <git@vger.kernel.org>
Cc: "Junio C Hamano" <gitster@pobox.com>,
	"Elijah Newren" <newren@gmail.com>,
	"Phillip Wood" <phillip.wood123@gmail.com>,
	"Eric Sunshine" <sunshine@sunshineco.com>,
	"Taylor Blau" <me@ttaylorr.com>,
	"Martin Ågren" <martin.agren@gmail.com>
Subject: [PATCH v3 1/2] git-merge-file doc: drop "-file" from argument placeholders
Date: Wed,  1 Nov 2023 19:24:18 +0000	[thread overview]
Message-ID: <20231101192419.794162-2-sandals@crustytoothpaste.net> (raw)
In-Reply-To: <20231101192419.794162-1-sandals@crustytoothpaste.net>

From: Martin Ågren <martin.agren@gmail.com>

`git merge-file` takes three positional arguments. Each of them is
documented as `<foo-file>`. In preparation for teaching this command to
alternatively take three object IDs, make these placeholders a bit more
generic by dropping the "-file" parts. Instead, clarify early that the
three arguments are filenames. Even after the next commit, we can afford
to present this file-centric view up front and in the general
discussion, since it will remain the default one.

Signed-off-by: Martin Ågren <martin.agren@gmail.com>
Signed-off-by: brian m. carlson <bk2204@github.com>
---
 Documentation/git-merge-file.txt | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
index 7e9093fab6..bf0a18cf02 100644
--- a/Documentation/git-merge-file.txt
+++ b/Documentation/git-merge-file.txt
@@ -11,19 +11,20 @@ SYNOPSIS
 [verse]
 'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
 	[--ours|--theirs|--union] [-p|--stdout] [-q|--quiet] [--marker-size=<n>]
-	[--[no-]diff3] <current-file> <base-file> <other-file>
+	[--[no-]diff3] <current> <base> <other>
 
 
 DESCRIPTION
 -----------
-'git merge-file' incorporates all changes that lead from the `<base-file>`
-to `<other-file>` into `<current-file>`. The result ordinarily goes into
-`<current-file>`. 'git merge-file' is useful for combining separate changes
-to an original. Suppose `<base-file>` is the original, and both
-`<current-file>` and `<other-file>` are modifications of `<base-file>`,
+Given three files `<current>`, `<base>` and `<other>`,
+'git merge-file' incorporates all changes that lead from `<base>`
+to `<other>` into `<current>`. The result ordinarily goes into
+`<current>`. 'git merge-file' is useful for combining separate changes
+to an original. Suppose `<base>` is the original, and both
+`<current>` and `<other>` are modifications of `<base>`,
 then 'git merge-file' combines both changes.
 
-A conflict occurs if both `<current-file>` and `<other-file>` have changes
+A conflict occurs if both `<current>` and `<other>` have changes
 in a common segment of lines. If a conflict is found, 'git merge-file'
 normally outputs a warning and brackets the conflict with lines containing
 <<<<<<< and >>>>>>> markers. A typical conflict will look like this:
@@ -36,8 +37,8 @@ normally outputs a warning and brackets the conflict with lines containing
 
 If there are conflicts, the user should edit the result and delete one of
 the alternatives.  When `--ours`, `--theirs`, or `--union` option is in effect,
-however, these conflicts are resolved favouring lines from `<current-file>`,
-lines from `<other-file>`, or lines from both respectively.  The length of the
+however, these conflicts are resolved favouring lines from `<current>`,
+lines from `<other>`, or lines from both respectively.  The length of the
 conflict markers can be given with the `--marker-size` option.
 
 The exit value of this program is negative on error, and the number of
@@ -62,7 +63,7 @@ OPTIONS
 
 -p::
 	Send results to standard output instead of overwriting
-	`<current-file>`.
+	`<current>`.
 
 -q::
 	Quiet; do not warn about conflicts.


  reply	other threads:[~2023-11-01 19:24 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-24 19:56 [PATCH 0/1] Object ID support for git merge-file brian m. carlson
2023-10-24 19:56 ` [PATCH 1/1] merge-file: add an option to process object IDs brian m. carlson
2023-10-24 20:12   ` Eric Sunshine
2023-10-24 21:23     ` brian m. carlson
2023-10-29  6:17   ` Elijah Newren
2023-10-29 10:12     ` Phillip Wood
2023-10-30 16:14       ` brian m. carlson
2023-10-29 14:18     ` brian m. carlson
2023-10-30 16:39       ` Elijah Newren
2023-10-29  6:24 ` [PATCH 0/1] Object ID support for git merge-file Elijah Newren
2023-10-29 10:15   ` Phillip Wood
2023-10-30 15:54   ` Taylor Blau
2023-10-30 16:24     ` brian m. carlson
2023-10-30 17:14       ` Elijah Newren
2023-10-30 16:26 ` [PATCH v2 " brian m. carlson
2023-10-30 16:26   ` [PATCH v2 1/1] merge-file: add an option to process object IDs brian m. carlson
2023-10-31 21:48     ` Martin Ågren
2023-10-31 22:31       ` brian m. carlson
2023-11-01  3:44         ` Junio C Hamano
2023-11-01 19:16           ` brian m. carlson
2023-10-30 17:15   ` [PATCH v2 0/1] Object ID support for git merge-file Elijah Newren
2023-10-31  0:03     ` Junio C Hamano
2023-10-31 11:05   ` Phillip Wood
2023-10-31 23:06     ` Junio C Hamano
2023-11-01 19:24 ` [PATCH v3 0/2] " brian m. carlson
2023-11-01 19:24   ` brian m. carlson [this message]
2023-11-01 23:53     ` [PATCH v3 1/2] git-merge-file doc: drop "-file" from argument placeholders Junio C Hamano
2023-11-02  8:53       ` Martin Ågren
2023-11-02  9:18         ` brian m. carlson
2023-11-02  9:29           ` Martin Ågren
2023-11-02 16:28         ` Junio C Hamano
2023-11-01 19:24   ` [PATCH v3 2/2] merge-file: add an option to process object IDs brian m. carlson
2023-11-02  8:51     ` Martin Ågren
2023-11-01 23:55   ` [PATCH v3 0/2] Object ID support for git merge-file 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=20231101192419.794162-2-sandals@crustytoothpaste.net \
    --to=sandals@crustytoothpaste.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=martin.agren@gmail.com \
    --cc=me@ttaylorr.com \
    --cc=newren@gmail.com \
    --cc=phillip.wood123@gmail.com \
    --cc=sunshine@sunshineco.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).