@matheusbsbs / matheus-bagliano / commits / 29b802aae6

Fork 0

Improve language in git-merge.txt and related docs

Improve some minor language and format issues like hyphenation, phrases, spacing, word order, comma, attributes. Signed-off-by: Junio C Hamano <gitster@pobox.com>

Ralf Wildenhues committed Dec 9, 2008 at 07:23 UTC 29b802aae6213d02879d21aabac1a8d2e035b583

9 files changed +48 -49

Documentation/git-fast-export.txt

+1 -1

@@ -15,7 +15,7 @@ DESCRIPTION

15 This program dumps the given revisions in a form suitable to be piped

16 into 'git-fast-import'.

18 -You can use it as a human readable bundle replacement (see

18 +You can use it as a human-readable bundle replacement (see

19 linkgit:git-bundle[1]), or as a kind of an interactive

20 'git-filter-branch'.

Documentation/git-merge-base.txt

+9 -10

@@ -16,15 +16,15 @@ DESCRIPTION

16 'git-merge-base' finds best common ancestor(s) between two commits to use

17 in a three-way merge. One common ancestor is 'better' than another common

18 ancestor if the latter is an ancestor of the former. A common ancestor

19 -that does not have any better common ancestor than it is a 'best common

19 +that does not have any better common ancestor is a 'best common

20 ancestor', i.e. a 'merge base'. Note that there can be more than one

21 -merge bases between two commits.

21 +merge base for a pair of commits.

23 -Among the two commits to compute their merge bases, one is specified by

23 +Among the two commits to compute the merge base from, one is specified by

24 the first commit argument on the command line; the other commit is a

25 (possibly hypothetical) commit that is a merge across all the remaining

26 -commits on the command line. As the most common special case, giving only

27 -two commits from the command line means computing the merge base between

26 +commits on the command line. As the most common special case, specifying only

27 +two commits on the command line means computing the merge base between

28 the given two commits.

30 OPTIONS

@@ -47,7 +47,7 @@ For example, with this topology:

47 the merge base between 'A' and 'B' is '1'.

49 Given three commits 'A', 'B' and 'C', `git merge-base A B C` will compute the

50 -merge base between 'A' and an hypothetical commit 'M', which is a merge

50 +merge base between 'A' and a hypothetical commit 'M', which is a merge

51 between 'B' and 'C'. For example, with this topology:

53 o---o---o---o---C

@@ -71,8 +71,7 @@ common ancestor between 'A' and 'M', but '1' is a better common ancestor,

71 because '2' is an ancestor of '1'. Hence, '2' is not a merge base.

73 When the history involves criss-cross merges, there can be more than one

74 -'best' common ancestors between two commits. For example, with this

75 -topology:

74 +'best' common ancestor for two commits. For example, with this topology:

76 ---1---o---A

77 \ /

@@ -80,8 +79,8 @@ topology:

79 / \

80 ---2---o---o---B

83 -both '1' and '2' are merge-base of A and B. Neither one is better than

84 -the other (both are 'best' merge base). When `--all` option is not given,

82 +both '1' and '2' are merge-bases of A and B. Neither one is better than

83 +the other (both are 'best' merge bases). When the `--all` option is not given,

84 it is unspecified which best one is output.

86 Author

Documentation/git-merge-file.txt

+6 -6

@@ -15,17 +15,17 @@ SYNOPSIS

16 DESCRIPTION

17 -----------

18 -'git-file-merge' incorporates all changes that lead from the `<base-file>`

18 +'git-merge-file' incorporates all changes that lead from the `<base-file>`

19 to `<other-file>` into `<current-file>`. The result ordinarily goes into

20 `<current-file>`. 'git-merge-file' is useful for combining separate changes

21 to an original. Suppose `<base-file>` is the original, and both

22 -`<current-file>` and `<other-file>` are modifications of `<base-file>`.

23 -Then 'git-merge-file' combines both changes.

22 +`<current-file>` and `<other-file>` are modifications of `<base-file>`,

23 +then 'git-merge-file' combines both changes.

25 A conflict occurs if both `<current-file>` and `<other-file>` have changes

26 in a common segment of lines. If a conflict is found, 'git-merge-file'

27 -normally outputs a warning and brackets the conflict with <<<<<<< and

28 ->>>>>>> lines. A typical conflict will look like this:

27 +normally outputs a warning and brackets the conflict with lines containing

28 +<<<<<<< and >>>>>>> markers. A typical conflict will look like this:

30 <<<<<<< A

31 lines in file A

@@ -60,7 +60,7 @@ OPTIONS

60 `<current-file>`.

62 -q::

63 - Quiet; do not warn about conflicts.

63 + Quiet; do not warn about conflicts.

66 EXAMPLES

Documentation/git-merge-index.txt

+3 -3

@@ -29,11 +29,11 @@ OPTIONS

29 Instead of stopping at the first failed merge, do all of them

30 in one shot - continue with merging even when previous merges

31 returned errors, and only return the error code after all the

32 - merges are over.

32 + merges.

34 -q::

35 - Do not complain about failed merge program (the merge program

36 - failure usually indicates conflicts during merge). This is for

35 + Do not complain about a failed merge program (a merge program

36 + failure usually indicates conflicts during the merge). This is for

37 porcelains which might want to emit custom messages.

39 If 'git-merge-index' is called with multiple <file>s (or -a) then it

Documentation/git-merge-tree.txt

+3 -3

@@ -14,14 +14,14 @@ DESCRIPTION

14 -----------

15 Reads three treeish, and output trivial merge results and

16 conflicting stages to the standard output. This is similar to

17 -what three-way read-tree -m does, but instead of storing the

17 +what three-way 'git read-tree -m' does, but instead of storing the

18 results in the index, the command outputs the entries to the

19 standard output.

21 This is meant to be used by higher level scripts to compute

22 -merge results outside index, and stuff the results back into the

22 +merge results outside of the index, and stuff the results back into the

23 index. For this reason, the output from the command omits

24 -entries that match <branch1> tree.

24 +entries that match the <branch1> tree.

26 Author

27 ------

Documentation/git-merge.txt

+17 -17

@@ -69,20 +69,20 @@ Three kinds of merge can happen:

69 simplest case, called "Already up-to-date."

71 * `HEAD` is already contained in the merged commit. This is the

72 - most common case especially when involved through 'git pull':

73 - you are tracking an upstream repository, committed no local

72 + most common case especially when invoked from 'git pull':

73 + you are tracking an upstream repository, have committed no local

74 changes and now you want to update to a newer upstream revision.

75 - Your `HEAD` (and the index) is updated to at point the merged

75 + Your `HEAD` (and the index) is updated to point at the merged

76 commit, without creating an extra merge commit. This is

77 called "Fast-forward".

79 * Both the merged commit and `HEAD` are independent and must be

80 - tied together by a merge commit that has them both as its parents.

80 + tied together by a merge commit that has both of them as its parents.

81 The rest of this section describes this "True merge" case.

83 The chosen merge strategy merges the two commits into a single

84 new source tree.

85 -When things cleanly merge, these things happen:

85 +When things merge cleanly, this is what happens:

87 1. The results are updated both in the index file and in your

88 working tree;

@@ -91,16 +91,16 @@ When things cleanly merge, these things happen:

91 4. The `HEAD` pointer gets advanced.

93 Because of 2., we require that the original state of the index

94 -file to match exactly the current `HEAD` commit; otherwise we

94 +file matches exactly the current `HEAD` commit; otherwise we

95 will write out your local changes already registered in your

96 index file along with the merge result, which is not good.

97 -Because 1. involves only the paths different between your

97 +Because 1. involves only those paths differing between your

98 branch and the remote branch you are pulling from during the

99 merge (which is typically a fraction of the whole tree), you can

100 have local modifications in your working tree as long as they do

101 not overlap with what the merge updates.

102

103 -When there are conflicts, these things happen:

103 +When there are conflicts, the following happens:

104

105 1. `HEAD` stays the same.

106

@@ -111,8 +111,8 @@ When there are conflicts, these things happen:

111 versions; stage1 stores the version from the common ancestor,

112 stage2 from `HEAD`, and stage3 from the remote branch (you

113 can inspect the stages with `git ls-files -u`). The working

114 - tree files have the result of "merge" program; i.e. 3-way

115 - merge result with familiar conflict markers `<<< === >>>`.

114 + tree files contain the result of the "merge" program; i.e. 3-way

115 + merge results with familiar conflict markers `<<< === >>>`.

116

117 4. No other changes are done. In particular, the local

118 modifications you had before you started merge will stay the

@@ -145,13 +145,13 @@ Git makes conflict resolution easy.

145 And here is another line that is cleanly resolved or unmodified.

146 ------------

147

148 -The area a pair of conflicting changes happened is marked with markers

148 +The area where a pair of conflicting changes happened is marked with markers

149 "`<<<<<<<`", "`=======`", and "`>>>>>>>`". The part before the "`=======`"

150 -is typically your side, and the part after it is typically their side.

150 +is typically your side, and the part afterwards is typically their side.

151

152 -The default format does not show what the original said in the conflicted

153 -area. You cannot tell how many lines are deleted and replaced with the

154 -Barbie's remark by your side. The only thing you can tell is that your

152 +The default format does not show what the original said in the conflicting

153 +area. You cannot tell how many lines are deleted and replaced with

154 +Barbie's remark on your side. The only thing you can tell is that your

155 side wants to say it is hard and you'd prefer to go shopping, while the

156 other side wants to claim it is easy.

157

@@ -186,14 +186,14 @@ HOW TO RESOLVE CONFLICTS

186

187 After seeing a conflict, you can do two things:

188

189 - * Decide not to merge. The only clean-up you need are to reset

189 + * Decide not to merge. The only clean-ups you need are to reset

190 the index file to the `HEAD` commit to reverse 2. and to clean

191 up working tree changes made by 2. and 3.; 'git-reset --hard' can

192 be used for this.

193

194 * Resolve the conflicts. Git will mark the conflicts in

195 the working tree. Edit the files into shape and

196 - 'git-add' to the index. 'git-commit' to seal the deal.

196 + 'git-add' them to the index. Use 'git-commit' to seal the deal.

197

198 You can work through the conflict with a number of tools:

199

Documentation/git-mergetool.txt

+2 -2

@@ -38,7 +38,7 @@ can configure the absolute path to kdiff3 by setting

38 `mergetool.kdiff3.path`. Otherwise, 'git-mergetool' assumes the

39 tool is available in PATH.

40 +

41 -Instead of running one of the known merge tool programs

41 +Instead of running one of the known merge tool programs,

42 'git-mergetool' can be customized to run an alternative program

43 by specifying the command line to invoke in a configuration

44 variable `mergetool.<tool>.cmd`.

@@ -55,7 +55,7 @@ of the file to which the merge tool should write the result of the

55 merge resolution.

56 +

57 If the custom merge tool correctly indicates the success of a

58 -merge resolution with its exit code then the configuration

58 +merge resolution with its exit code, then the configuration

59 variable `mergetool.<tool>.trustExitCode` can be set to `true`.

60 Otherwise, 'git-mergetool' will prompt the user to indicate the

61 success of the resolution after the custom tool has exited.

Documentation/merge-config.txt

+6 -6

@@ -1,10 +1,10 @@

1 merge.conflictstyle::

2 Specify the style in which conflicted hunks are written out to

3 working tree files upon merge. The default is "merge", which

4 - shows `<<<<<<<` conflict marker, change made by one side,

5 - `=======` marker, change made by the other side, and then

6 - `>>>>>>>` marker. An alternate style, "diff3", adds `|||||||`

7 - marker and the original text before `=======` marker.

4 + shows a `<<<<<<<` conflict marker, changes made by one side,

5 + a `=======` marker, changes made by the other side, and then

6 + a `>>>>>>>` marker. An alternate style, "diff3", adds a `|||||||`

7 + marker and the original text before the `=======` marker.

9 merge.log::

10 Whether to include summaries of merged commits in newly created

@@ -32,10 +32,10 @@ merge.verbosity::

32 message if conflicts were detected. Level 1 outputs only

33 conflicts, 2 outputs conflicts and file changes. Level 5 and

34 above outputs debugging information. The default is level 2.

35 - Can be overridden by 'GIT_MERGE_VERBOSITY' environment variable.

35 + Can be overridden by the 'GIT_MERGE_VERBOSITY' environment variable.

37 merge.<driver>.name::

38 - Defines a human readable name for a custom low-level

38 + Defines a human-readable name for a custom low-level

39 merge driver. See linkgit:gitattributes[5] for details.

41 merge.<driver>.driver::

Documentation/merge-options.txt

+1 -1

@@ -12,7 +12,7 @@

13 -n::

14 --no-stat::

15 - Do not show diffstat at the end of the merge.

15 + Do not show a diffstat at the end of the merge.

17 --summary::

18 --no-summary::