Autogenerated man pages for v1.4.3.4-gbd45
authorJunio C Hamano <junio@hera.kernel.org>
Tue, 7 Nov 2006 07:19:24 +0000 (07:19 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Tue, 7 Nov 2006 07:19:24 +0000 (07:19 +0000)
man1/git-pack-refs.1 [new file with mode: 0755]
man1/git-rebase.1
man7/git.7

diff --git a/man1/git-pack-refs.1 b/man1/git-pack-refs.1
new file mode 100755 (executable)
index 0000000..c62122f
--- /dev/null
@@ -0,0 +1,36 @@
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "GIT\-PACK\-REFS" "1" "11/07/2006" "" ""
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+git\-pack\-refs \- Pack heads and tags for efficient repository access
+.SH "SYNOPSIS"
+\fIgit\-pack\-refs\fR [\-\-all] [\-\-prune]
+.sp
+.SH "DESCRIPTION"
+Traditionally, tips of branches and tags (collectively known as \fIrefs\fR) were stored one file per ref under $GIT_DIR/refs directory. While many branch tips tend to be updated often, most tags and some branch tips are never updated. When a repository has hundreds or thousands of tags, this one\-file\-per\-ref format both wastes storage and hurts performance.
+.sp
+This command is used to solve the storage and performance problem by stashing the refs in a single file, $GIT_DIR/packed\-refs. When a ref is missing from the traditional $GIT_DIR/refs hierarchy, it is looked up in this file and used if found.
+.sp
+Subsequent updates to branches always creates new file under $GIT_DIR/refs hierarchy.
+.sp
+.SH "OPTIONS"
+.TP
+\-\-all
+The command by default packs all tags and leaves branch tips alone. This is because branches are expected to be actively developed and packing their tips does not help performance. This option causes branch tips to be packed as well. Useful for a repository with many branches of historical interests.
+.TP
+\-\-prune
+After packing the refs, remove loose refs under
+$GIT_DIR/refs
+hierarchy. This should probably become default.
+.SH "AUTHOR"
+Written by Linus Torvalds <torvalds@osdl.org>
+.sp
+.SH "GIT"
+Part of the \fBgit\fR(7) suite
+.sp
index 6f61dc4c526ca5b9eb9aa3304454678429023859..eaacdf077c8cf72b2a0e84d93a70248ac00e4754 100755 (executable)
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT\-REBASE" "1" "10/19/2006" "" ""
+.TH "GIT\-REBASE" "1" "11/07/2006" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -44,21 +44,64 @@ would be:
                  /
     D\-\-\-E\-\-\-F\-\-\-G master
 .fi
-While, starting from the same point, the result of either of the following commands:
+The latter form is just a short\-hand of git checkout topic followed by git rebase master.
+.sp
+Here is how you would transplant a topic branch based on one branch to another, to pretend that you forked the topic branch from the latter branch, using rebase \-\-onto.
+.sp
+First let's assume your \fItopic\fR is based on branch \fInext\fR. For example feature developed in \fItopic\fR depends on some functionality which is found in \fInext\fR.
 .sp
 .sp
 .nf
-git\-rebase \-\-onto master~1 master
-git\-rebase \-\-onto master~1 master topic
+    o\-\-\-o\-\-\-o\-\-\-o\-\-\-o  master
+         \\
+          o\-\-\-o\-\-\-o\-\-\-o\-\-\-o  next
+                           \\
+                            o\-\-\-o\-\-\-o  topic
 .fi
-would be:
+We would want to make \fItopic\fR forked from branch \fImaster\fR, for example because the functionality \fItopic\fR branch depend on got merged into more stable \fImaster\fR branch, like this:
 .sp
 .sp
 .nf
-              A'\-\-B'\-\-C' topic
-             /
-    D\-\-\-E\-\-\-F\-\-\-G master
+    o\-\-\-o\-\-\-o\-\-\-o\-\-\-o  master
+        |            \\
+        |             o'\-\-o'\-\-o'  topic
+         \\
+          o\-\-\-o\-\-\-o\-\-\-o\-\-\-o  next
+.fi
+We can get this using the following command:
+.sp
+.sp
+.nf
+git\-rebase \-\-onto master next topic
+.fi
+Another example of \-\-onto option is to rebase part of a branch. If we have the following situation:
+.sp
+.sp
+.nf
+                            H\-\-\-I\-\-\-J topicB
+                           /
+                  E\-\-\-F\-\-\-G  topicA
+                 /
+    A\-\-\-B\-\-\-C\-\-\-D  master
+.fi
+then the command
+.sp
+.sp
+.nf
+git\-rebase \-\-onto master topicA topicB
 .fi
+would result in:
+.sp
+.sp
+.nf
+                 H'\-\-I'\-\-J'  topicB
+                /
+                | E\-\-\-F\-\-\-G  topicA
+                |/
+    A\-\-\-B\-\-\-C\-\-\-D  master
+.fi
+This is useful when topicB does not depend on topicA.
+.sp
 In case of conflict, git\-rebase will stop at the first problematic commit and leave conflict markers in the tree. You can use git diff to locate the markers (<<<<<<) and make edits to resolve the conflict. For each file you edit, you need to tell git that the conflict has been resolved, typically this would be done with
 .sp
 .sp
index 5c21d138fa73a6926d2a698ef32b6078a3576292..c3e61b61c2ab2a1429d12af547bba743c2ae03f2 100755 (executable)
@@ -2,7 +2,7 @@
 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
 .\" Instead of manually editing it, you probably should edit the DocBook XML
 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
-.TH "GIT" "7" "10/29/2006" "" ""
+.TH "GIT" "7" "11/07/2006" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -126,6 +126,9 @@ Grand unified merge driver.
 \fBgit\-mv\fR(1)
 Move or rename a file, a directory, or a symlink.
 .TP
+\fBgit\-pack\-refs\fR(1)
+Pack heads and tags for efficient repository access.
+.TP
 \fBgit\-pull\fR(1)
 Fetch from and merge with a remote repository or a local branch.
 .TP
@@ -392,6 +395,9 @@ Lists commit objects in reverse chronological order.
 \fBgit\-show\-index\fR(1)
 Displays contents of a pack idx file.
 .TP
+\fBgit\-show\-ref\fR(1)
+List references in a local repository.
+.TP
 \fBgit\-tar\-tree\fR(1)
 Creates a tar archive of the files in the named tree object.
 .TP