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 <martin.agren@gmail.com> Signed-off-by: brian m. carlson <bk2204@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Martin Ågren committed
Nov 1, 2023 at 19:24 UTC
8077612ea12e80b20e307e279916710b99fe6362
1 file changed
+11
-10
Documentation/git-merge-file.txt
+11
-10
@@ -11,19 +11,20 @@ SYNOPSIS
11
[verse]
12
'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
13
[--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>
15
16
17
DESCRIPTION
18
-----------
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>`,
25
then 'git merge-file' combines both changes.
26
26
-A conflict occurs if both `<current-file>` and `<other-file>` have changes
27
+A conflict occurs if both `<current>` and `<other>` have changes
28
in a common segment of lines. If a conflict is found, 'git merge-file'
29
normally outputs a warning and brackets the conflict with lines containing
30
<<<<<<< and >>>>>>> markers. A typical conflict will look like this:
@@ -36,8 +37,8 @@ normally outputs a warning and brackets the conflict with lines containing
37
38
If there are conflicts, the user should edit the result and delete one of
39
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
42
conflict markers can be given with the `--marker-size` option.
43
44
The exit value of this program is negative on error, and the number of
@@ -62,7 +63,7 @@ OPTIONS
63
64
-p::
65
Send results to standard output instead of overwriting
65
- `<current-file>`.
66
+ `<current>`.
67
68
-q::
69
Quiet; do not warn about conflicts.