From 4f571479384cf81c4526ae29d8c79843aefd3cd1 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Tue, 4 Dec 2007 00:40:55 -0800 Subject: Documentation: rerere is enabled by default these days. Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 4 ---- 1 file changed, 4 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index c4d4263238..8ce492c8f2 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -22,10 +22,6 @@ 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. -[NOTE] -You need to set the config variable rerere.enabled to enable this -command. - COMMANDS -------- -- cgit v1.2.3 From 5162e69732d13dd079919a389a6ace8878aad716 Mon Sep 17 00:00:00 2001 From: Dan McGee Date: Sat, 29 Dec 2007 00:20:38 -0600 Subject: Documentation: rename gitlink macro to linkgit Between AsciiDoc 8.2.2 and 8.2.3, the following change was made to the stock Asciidoc configuration: @@ -149,7 +153,10 @@ # Inline macros. # Backslash prefix required for escape processing. # (?s) re flag for line spanning. -(?su)[\\]?(?P\w(\w|-)*?):(?P\S*?)(\[(?P.*?)\])= + +# Explicit so they can be nested. +(?su)[\\]?(?P(http|https|ftp|file|mailto|callto|image|link)):(?P\S*?)(\[(?P.*?)\])= + # Anchor: [[[id]]]. Bibliographic anchor. (?su)[\\]?\[\[\[(?P[\w][\w-]*?)\]\]\]=anchor3 # Anchor: [[id,xreflabel]] This default regex now matches explicit values, and unfortunately in this case gitlink was being matched by just 'link', causing the wrong inline macro template to be applied. By renaming the macro, we can avoid being matched by the wrong regex. Signed-off-by: Dan McGee Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 8ce492c8f2..3793267dad 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -33,7 +33,7 @@ its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling gitlink:git-am[1] --skip or gitlink:git-rebase[1] +is aborted. Calling linkgit:git-am[1] --skip or linkgit:git-rebase[1] [--skip|--abort] will automatically invoke this command. 'diff':: @@ -204,4 +204,4 @@ Written by Junio C Hamano GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[7] suite -- cgit v1.2.3 From 11c57e6a9a0f31f970701a673adaa1826f502fa0 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 14 Jan 2008 15:10:38 -0800 Subject: Fix git-rerere documentation rerere.enabled is _not_ on by default. The command is enabled if rr-cache exists even when rerere.enabled is missing, and enabled or disabled by explicitly setting the rerere.enabled variable. --- Documentation/git-rerere.txt | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 3793267dad..a53858e250 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -22,6 +22,10 @@ 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. +[NOTE] +You need to set the configuration variable rerere.enabled to +enable this command. + COMMANDS -------- -- cgit v1.2.3 From 9e1f0a85c68323830ea117092c55192b17aa3ac8 Mon Sep 17 00:00:00 2001 From: Christian Couder Date: Fri, 6 Jun 2008 09:07:32 +0200 Subject: documentation: move git(7) to git(1) As the "git" man page describes the "git" command at the end-user level, it seems better to move it to man section 1. Signed-off-by: Christian Couder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index a53858e250..8030ec4d01 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -208,4 +208,4 @@ Written by Junio C Hamano GIT --- -Part of the linkgit:git[7] suite +Part of the linkgit:git[1] suite -- cgit v1.2.3 From b1889c36d85514e5e70462294c561a02c2edfe2b Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 01:09:04 -0500 Subject: Documentation: be consistent about "git-" versus "git " Since the git-* commands are not installed in $(bindir), using "git-command " in examples in the documentation is not a good idea. On the other hand, it is nice to be able to refer to each command using one hyphenated word. (There is no escaping it, anyway: man page names cannot have spaces in them.) This patch retains the dash in naming an operation, command, program, process, or action. Complete command lines that can be entered at a shell (i.e., without options omitted) are made to use the dashless form. The changes consist only of replacing some spaces with hyphens and vice versa. After a "s/ /-/g", the unpatched and patched versions are identical. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 8030ec4d01..d712f62c5f 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges SYNOPSIS -------- -'git-rerere' [clear|diff|status|gc] +'git rerere' [clear|diff|status|gc] DESCRIPTION ----------- @@ -198,7 +198,7 @@ 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 +`git-rerere` is run by `git-rebase` to help you resolve this conflict. -- cgit v1.2.3 From 483bc4f045881b998512ae814d6cf44d0c0cb493 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Mon, 30 Jun 2008 13:56:34 -0500 Subject: Documentation formatting and cleanup Following what appears to be the predominant style, format names of commands and commandlines both as `teletype text`. While we're at it, add articles ("a" and "the") in some places, italicize the name of the command in the manual page synopsis line, and add a comma or two where it seems appropriate. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index d712f62c5f..3458029042 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -30,22 +30,22 @@ enable this command. COMMANDS -------- -Normally, git-rerere is run without arguments or user-intervention. +Normally, `git-rerere` is run without arguments or user-intervention. However, it has several commands that allow it to interact with its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling linkgit:git-am[1] --skip or linkgit:git-rebase[1] -[--skip|--abort] will automatically invoke this command. +is aborted. Calling `git-am --skip` or `git-rebase [--skip|--abort]` +will automatically invoke this command. 'diff':: This displays diffs for the current state of the resolution. It is useful for tracking what has changed while the user is resolving conflicts. Additional arguments are passed directly to the system -diff(1) command installed in PATH. +`diff` command installed in PATH. 'status':: @@ -146,7 +146,7 @@ blew away. `git-rerere` command helps you to resolve this final conflicted merge using the information from your earlier hand resolve. -Running `git-rerere` command immediately after a conflicted +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, -- cgit v1.2.3 From 467c0197fd0a49078d05839ee385046cd3707a5b Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:28:15 -0500 Subject: Documentation: more "git-" versus "git " changes With git-commands moving out of $(bindir), it is useful to make a clearer distinction between the git subcommand 'git-whatever' and the command you type, `git whatever `. So we use a dash after "git" when referring to the former and not the latter. I already sent a patch doing this same thing, but I missed some spots. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 3458029042..ae2b2b543a 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -163,7 +163,7 @@ If this three-way merge resolves cleanly, the result is written out to your working tree file, so you would 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. +(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 -- cgit v1.2.3 From 0979c106498f21838140313b485f90faf06f454f Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:37:18 -0500 Subject: manpages: italicize command names This includes nongit commands like RCS 'merge'. This patch only italicizes names of commands if they had no formatting before. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index ae2b2b543a..30ec68d3eb 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -7,7 +7,7 @@ git-rerere - Reuse recorded resolution of conflicted merges SYNOPSIS -------- -'git rerere' [clear|diff|status|gc] +'git rerere' ['clear'|'diff'|'status'|'gc'] DESCRIPTION ----------- @@ -49,7 +49,7 @@ conflicts. Additional arguments are passed directly to the system 'status':: -Like diff, but this only prints the filenames that will be tracked +Like 'diff', but this only prints the filenames that will be tracked for resolutions. 'gc':: -- cgit v1.2.3 From ba020ef5eb5fca3d757bd580ff117adaf81ca079 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:41:41 -0500 Subject: manpages: italicize git command names (which were in teletype font) The names of git commands are not meant to be entered at the commandline; they are just names. So we render them in italics, as is usual for command names in manpages. Using doit () { perl -e 'for (<>) { s/\`(git-[^\`.]*)\`/'\''\1'\''/g; print }' } for i in git*.txt config.txt diff*.txt blame*.txt fetch*.txt i18n.txt \ merge*.txt pretty*.txt pull*.txt rev*.txt urls*.txt do doit <"$i" >"$i+" && mv "$i+" "$i" done git diff . Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 30ec68d3eb..666349d178 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -30,14 +30,14 @@ enable this command. COMMANDS -------- -Normally, `git-rerere` is run without arguments or user-intervention. +Normally, 'git-rerere' is run without arguments or user-intervention. However, it has several commands that allow it to interact with its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling `git-am --skip` or `git-rebase [--skip|--abort]` +is aborted. Calling 'git-am --skip' or 'git-rebase [--skip|--abort]' will automatically invoke this command. 'diff':: @@ -142,33 +142,33 @@ 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 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' command helps you to resolve this final conflicted merge using the information from your earlier hand resolve. -Running the `git-rerere` command immediately after a conflicted +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 records 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 +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 earlier conflicted automerge, the earlier manual resolution, and the current conflicted automerge is performed by the command. If this three-way merge resolves cleanly, the result is written out to your working tree file, so you would not have to manually -resolve it. Note that `git-rerere` leaves the index file alone, +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. +(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 +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 -resolve when it is not. `git-commit` also invokes `git-rerere` +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). @@ -178,8 +178,8 @@ 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. -The information `git-rerere` records is also used when running -`git-rebase`. After blowing away the test merge and continuing +The information 'git-rerere' records is also used when running +'git-rebase'. After blowing away the test merge and continuing development on the topic branch: ------------ @@ -198,7 +198,7 @@ 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 +'git-rerere' is run by 'git-rebase' to help you resolve this conflict. -- cgit v1.2.3 From 2fd02c92dbb6e575b7e62ea9dfa85ef45ebe58b6 Mon Sep 17 00:00:00 2001 From: Jonathan Nieder Date: Thu, 3 Jul 2008 00:55:07 -0500 Subject: manpages: italicize nongit command names (if they are in teletype font) Some manual pages use teletype font to set command names. We change them to use italics, instead. This creates a visual distinction between names of commands and command lines that can be typed at the command line. It is also more consistent with other man pages outside Git. In this patch, the commands named are non-git commands like bash. Signed-off-by: Jonathan Nieder Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 666349d178..678bfd3cde 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -45,7 +45,7 @@ will automatically invoke this command. This displays diffs for the current state of the resolution. It is useful for tracking what has changed while the user is resolving conflicts. Additional arguments are passed directly to the system -`diff` command installed in PATH. +'diff' command installed in PATH. 'status':: -- cgit v1.2.3 From 59eb68aa2b4e52aa1d098e0d76c5130864ceff2e Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 21 Jul 2008 12:14:42 -0700 Subject: Update my e-mail address The old cox.net address is still getting mails from gitters. Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 678bfd3cde..beebd5301f 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -204,7 +204,7 @@ conflict. Author ------ -Written by Junio C Hamano +Written by Junio C Hamano GIT --- -- cgit v1.2.3 From a31c00b00eeadbc4b87ce2d578688e9b369a50fe Mon Sep 17 00:00:00 2001 From: Stephan Beyer Date: Wed, 23 Jul 2008 02:10:25 +0200 Subject: am --abort: Add to bash-completion and mention in git-rerere documentation The git-rerere documentation talks about commands that invoke "git rerere clear" automatically. git am --abort is added and a typo is fixed additionally. Signed-off-by: Stephan Beyer Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index beebd5301f..89f321b414 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -37,7 +37,7 @@ its working state. 'clear':: This resets the metadata used by rerere if a merge resolution is to be -is aborted. Calling 'git-am --skip' or 'git-rebase [--skip|--abort]' +aborted. Calling 'git-am [--skip|--abort]' or 'git-rebase [--skip|--abort]' will automatically invoke this command. 'diff':: -- cgit v1.2.3 From 1ceb95c8041cad1c25c73fd08e8c0c7ee28cf704 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 21 Jul 2008 12:14:42 -0700 Subject: Update my e-mail address The old cox.net address is still getting mails from gitters. Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 8030ec4d01..37828e5c5a 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -204,7 +204,7 @@ conflict. Author ------ -Written by Junio C Hamano +Written by Junio C Hamano GIT --- -- cgit v1.2.3 From 0f4f4d1597219bad74c4fde624321d8a05d1b55e Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 7 Aug 2008 16:05:25 -0700 Subject: asciidoc markup fixes I see quite a few pages on k.org site, e.g. http://www.kernel.org/pub/software/scm/git/docs/git-rerere.html (scroll down to find "After this test merge") are misformatted to lose teletype text '+' that is followed by a comma, and turns the following paragraph all typeset in teletype. This patch seems to fix the issue at the site (meaning, with the particular vintage of asciidoc and docbook toolchain), without breaking things with the version I have at my primary development machine, but wider testing is very much appreciated. After this patch, git grep '`+`,' -- Documentation should report noting. Signed-off-by: Junio C Hamano --- Documentation/git-rerere.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'Documentation/git-rerere.txt') diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt index 37828e5c5a..8f12dc9759 100644 --- a/Documentation/git-rerere.txt +++ b/Documentation/git-rerere.txt @@ -90,15 +90,15 @@ One way to do it is to pull master into the topic branch: The commits marked with `*` touch the same area in the same file; you need to resolve the conflicts when creating the commit -marked with `+`. Then you can test the result to make sure your +marked with `{plus}`. Then you can test the result to make sure your work-in-progress still works with what is in the latest master. After this test merge, there are two ways to continue your work on the topic. The easiest is to build on top of the test merge -commit `+`, and when your work in the topic branch is finally +commit `{plus}`, and when your work in the topic branch is finally ready, pull the topic branch into master, and/or ask the upstream to pull from you. By that time, however, the master or -the upstream might have been advanced since the test merge `+`, +the upstream might have been advanced since the test merge `{plus}`, in which case the final commit graph would look like this: ------------ -- cgit v1.2.3