Skip to content

Commit 8077612

Browse files
Martin Ågrengitster
authored andcommitted
git-merge-file doc: drop "-file" from argument placeholders
`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 <[email protected]> Signed-off-by: brian m. carlson <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 43c8a30 commit 8077612

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

Documentation/git-merge-file.txt

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,20 @@ SYNOPSIS
1111
[verse]
1212
'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
1313
[--ours|--theirs|--union] [-p|--stdout] [-q|--quiet] [--marker-size=<n>]
14-
[--[no-]diff3] <current-file> <base-file> <other-file>
14+
[--[no-]diff3] <current> <base> <other>
1515

1616

1717
DESCRIPTION
1818
-----------
19-
'git merge-file' incorporates all changes that lead from the `<base-file>`
20-
to `<other-file>` into `<current-file>`. The result ordinarily goes into
21-
`<current-file>`. 'git merge-file' is useful for combining separate changes
22-
to an original. Suppose `<base-file>` is the original, and both
23-
`<current-file>` and `<other-file>` are modifications of `<base-file>`,
19+
Given three files `<current>`, `<base>` and `<other>`,
20+
'git merge-file' incorporates all changes that lead from `<base>`
21+
to `<other>` into `<current>`. The result ordinarily goes into
22+
`<current>`. 'git merge-file' is useful for combining separate changes
23+
to an original. Suppose `<base>` is the original, and both
24+
`<current>` and `<other>` are modifications of `<base>`,
2425
then 'git merge-file' combines both changes.
2526

26-
A conflict occurs if both `<current-file>` and `<other-file>` have changes
27+
A conflict occurs if both `<current>` and `<other>` have changes
2728
in a common segment of lines. If a conflict is found, 'git merge-file'
2829
normally outputs a warning and brackets the conflict with lines containing
2930
<<<<<<< and >>>>>>> markers. A typical conflict will look like this:
@@ -36,8 +37,8 @@ normally outputs a warning and brackets the conflict with lines containing
3637

3738
If there are conflicts, the user should edit the result and delete one of
3839
the alternatives. When `--ours`, `--theirs`, or `--union` option is in effect,
39-
however, these conflicts are resolved favouring lines from `<current-file>`,
40-
lines from `<other-file>`, or lines from both respectively. The length of the
40+
however, these conflicts are resolved favouring lines from `<current>`,
41+
lines from `<other>`, or lines from both respectively. The length of the
4142
conflict markers can be given with the `--marker-size` option.
4243

4344
The exit value of this program is negative on error, and the number of
@@ -62,7 +63,7 @@ OPTIONS
6263

6364
-p::
6465
Send results to standard output instead of overwriting
65-
`<current-file>`.
66+
`<current>`.
6667

6768
-q::
6869
Quiet; do not warn about conflicts.

0 commit comments

Comments
 (0)