summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorStephen Boyd <bebarino@gmail.com>2009-06-13 18:20:00 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-06-13 19:44:41 (GMT)
commitc97038d1cfbd98ea258086c417fe4f0c094596d3 (patch)
treec50f3e9eaa93aa14b12febeb95f63024debd68e6 /Documentation
parent6589ebf107214a9e6db31764e847301f1adebc81 (diff)
downloadgit-c97038d1cfbd98ea258086c417fe4f0c094596d3.zip
git-c97038d1cfbd98ea258086c417fe4f0c094596d3.tar.gz
git-c97038d1cfbd98ea258086c417fe4f0c094596d3.tar.bz2
git-rerere.txt: grammatical fixups and cleanups
Rewrite the gc section using unresolved and resolved instead of "not recorded". Add plurals and missing articles. Make some sentences have consistent tense. Try and be more active by removing "that" and simplifying sentences. The terms "hand-resolve" and "hand resolve" were used, so just use "hand resolve" to be more consistent. Signed-off-by: Stephen Boyd <bebarino@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-rerere.txt65
1 files changed, 32 insertions, 33 deletions
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index 64715c1..a53c3cd 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -12,15 +12,15 @@ SYNOPSIS
DESCRIPTION
-----------
-In a workflow that employs relatively long lived topic branches,
-the developer sometimes needs to resolve the same conflict over
+In a workflow employing relatively long lived topic branches,
+the developer sometimes needs to resolve the same conflicts over
and over again until the topic branches are done (either merged
to the "release" branch, or sent out and accepted upstream).
-This command helps this process by recording conflicted
-automerge results and corresponding hand-resolve results on the
-initial manual merge, and later by noticing the same automerge
-results and applying the previously recorded hand resolution.
+This command assists the developer in this process by recording
+conflicted automerge results and corresponding hand resolve results
+on the initial manual merge, and applying previously recorded
+hand resolutions to their corresponding automerge results.
[NOTE]
You need to set the configuration variable rerere.enabled to
@@ -54,18 +54,18 @@ for resolutions.
'gc'::
-This command is used to prune records of conflicted merge that
-occurred long time ago. By default, conflicts older than 15
-days that you have not recorded their resolution, and conflicts
-older than 60 days, are pruned. These are controlled with
+This prunes records of conflicted merges that
+occurred a long time ago. By default, unresolved conflicts older
+than 15 days and resolved conflicts older than 60
+days are pruned. These defaults are controlled via the
`gc.rerereunresolved` and `gc.rerereresolved` configuration
-variables.
+variables respectively.
DISCUSSION
----------
-When your topic branch modifies overlapping area that your
+When your topic branch modifies an overlapping area that your
master branch (or upstream) touched since your topic branch
forked from it, you may want to test it with the latest master,
even before your topic branch is ready to be pushed upstream:
@@ -140,9 +140,9 @@ top of the tip before the test merge:
This would leave only one merge commit when your topic branch is
finally ready and merged into the master branch. This merge
would require you to resolve the conflict, introduced by the
-commits marked with `*`. However, often this conflict is the
+commits marked with `*`. However, this conflict is often the
same conflict you resolved when you created the test merge you
-blew away. 'git-rerere' command helps you to resolve this final
+blew away. 'git-rerere' helps you resolve this final
conflicted merge using the information from your earlier hand
resolve.
@@ -150,33 +150,32 @@ Running the 'git-rerere' command immediately after a conflicted
automerge records the conflicted working tree files, with the
usual conflict markers `<<<<<<<`, `=======`, and `>>>>>>>` in
them. Later, after you are done resolving the conflicts,
-running 'git-rerere' again records the resolved state of these
+running 'git-rerere' again will record the resolved state of these
files. Suppose you did this when you created the test merge of
master into the topic branch.
-Next time, running 'git-rerere' after seeing a conflicted
-automerge, if the conflict is the same as the earlier one
-recorded, it is noticed and a three-way merge between the
+Next time, after seeing the same conflicted automerge,
+running 'git-rerere' will perform a three-way merge between the
earlier conflicted automerge, the earlier manual resolution, and
-the current conflicted automerge is performed by the command.
+the current conflicted automerge.
If this three-way merge resolves cleanly, the result is written
-out to your working tree file, so you would not have to manually
+out to your working tree file, so you do not have to manually
resolve it. Note that 'git-rerere' leaves the index file alone,
so you still need to do the final sanity checks with `git diff`
(or `git diff -c`) and 'git-add' when you are satisfied.
As a convenience measure, 'git-merge' automatically invokes
-'git-rerere' when it exits with a failed automerge, which
-records it if it is a new conflict, or reuses the earlier hand
+'git-rerere' upon exiting with a failed automerge and 'git-rerere'
+records the hand resolve when it is a new conflict, or reuses the earlier hand
resolve when it is not. 'git-commit' also invokes 'git-rerere'
-when recording a merge result. What this means is that you do
-not have to do anything special yourself (Note: you still have
-to set the config variable rerere.enabled to enable this command).
+when committing a merge result. What this means is that you do
+not have to do anything special yourself (besides enabling
+the rerere.enabled config variable).
-In our example, when you did the test merge, the manual
+In our example, when you do the test merge, the manual
resolution is recorded, and it will be reused when you do the
-actual merge later with updated master and topic branch, as long
-as the earlier resolution is still applicable.
+actual merge later with the updated master and topic branch, as long
+as the recorded resolution is still applicable.
The information 'git-rerere' records is also used when running
'git-rebase'. After blowing away the test merge and continuing
@@ -194,11 +193,11 @@ development on the topic branch:
o---o---o---*---o---o---o---o master
------------
-you could run `git rebase master topic`, to keep yourself
-up-to-date even before your topic is ready to be sent upstream.
-This would result in falling back to three-way merge, and it
-would conflict the same way the test merge you resolved earlier.
-'git-rerere' is run by 'git-rebase' to help you resolve this
+you could run `git rebase master topic`, to bring yourself
+up-to-date before your topic is ready to be sent upstream.
+This would result in falling back to a three-way merge, and it
+would conflict the same way as the test merge you resolved earlier.
+'git-rerere' will be run by 'git-rebase' to help you resolve this
conflict.