Autogenerated man pages for v1.5.0-rc0-gf4bf2
authorJunio C Hamano <junio@hera.kernel.org>
Tue, 2 Jan 2007 00:04:25 +0000 (00:04 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Tue, 2 Jan 2007 00:04:25 +0000 (00:04 +0000)
man1/git-clone.1
man1/git-fetch.1
man1/git-pull.1

index 92216cd0223e1ec2df497aee97753f17b847198f..a183bc880e54233af33141dc72a8d7c27212eb67 100644 (file)
@@ -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\-CLONE" "1" "01/01/2007" "" ""
+.TH "GIT\-CLONE" "1" "01/02/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -14,7 +14,7 @@ git\-clone \- Clones a repository
 .nf
 \fIgit\-clone\fR [\-\-template=<template_directory>] [\-l [\-s]] [\-q] [\-n] [\-\-bare]
           [\-o <name>] [\-u <upload\-pack>] [\-\-reference <repository>]
-          <repository> [<directory>]
+          [\-\-depth=<depth>] <repository> [<directory>]
 .fi
 .SH "DESCRIPTION"
 Clones a repository into a newly created directory, creates remote\-tracking branches for each branch in the cloned repository (visible using git branch \-r), and creates and checks out a master branch equal to the cloned repository's master branch.
@@ -51,6 +51,9 @@ When given, and the repository to clone from is handled by \fIgit\-fetch\-pack\f
 \-\-template=<template_directory>
 Specify the directory from which templates will be used; if unset the templates are taken from the installation defined default, typically /usr/share/git\-core/templates.
 .TP
+\-\-depth=<depth>
+Create a \fIshallow\fR clone with a history truncated to the specified number of revs. A shallow repository has number of limitations (you cannot clone or fetch from it, nor push from nor into it), but is adequate if you want to only look at near the tip of a large project with a long history, and would want to send in a fixes as patches.
+.TP
 <repository>
 The (possibly remote) repository to clone from. It can be any URL git\-fetch supports.
 .TP
index cb4165c3bf4d5e96edb0f53cb8f7a5f6da9d436a..1b76c173d3b91040348afcc9e3afe1955c0bf06b 100644 (file)
@@ -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\-FETCH" "1" "01/01/2007" "" ""
+.TH "GIT\-FETCH" "1" "01/02/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -36,7 +36,10 @@ Most of the tags are fetched automatically as branch heads are downloaded, but t
 Keep downloaded pack.
 .TP
 \-u, \-\-update\-head\-ok
-By default git\-fetch refuses to update the head which corresponds to the current branch. This flag disables the check. Note that fetching into the current branch will not update the index and working directory, so use it with care.
+By default git\-fetch refuses to update the head which corresponds to the current branch. This flag disables the check. This is purely for the internal use for git\-pull to communicate with git\-fetch, and unless you are implementing your own Porcelain you are not supposed to use it.
+.TP
+\-\-depth=<depth>
+Deepen the history of a \fIshallow\fR repository created by git clone with \-\-depth=<depth> option (see \fBgit\-clone\fR(1)) by the specified number of commits.
 .TP
 <repository>
 The "remote" repository that is the source of a fetch or pull operation. See the section GIT URLS below.
@@ -58,7 +61,7 @@ If the remote branch from which you want to pull is modified in non\-linear ways
 .nr an-break-flag 1
 .br
 \fBNote\fR
-You never do your own development on branches that appear on the right hand side of a <refspec> colon on Pull: lines; they are to be updated by git\-fetch. If you intend to do development derived from a remote branch B, have a Pull: line to track it (i.e. Pull: B:remote\-B), and have a separate branch my\-B to do your development on top of it. The latter is created by git branch my\-B remote\-B (or its equivalent git checkout \-b my\-B remote\-B). Run git fetch to keep track of the progress of the remote side, and when you see something new on the remote branch, merge it into your development branch with git pull . remote\-B, while you are on my\-B branch. The common Pull: master:origin mapping of a remote master branch to a local origin branch, which is then merged to a local development branch, again typically named master, is made when you run git clone for you to follow this pattern.
+You never do your own development on branches that appear on the right hand side of a <refspec> colon on Pull: lines; they are to be updated by git\-fetch. If you intend to do development derived from a remote branch B, have a Pull: line to track it (i.e. Pull: B:remote\-B), and have a separate branch my\-B to do your development on top of it. The latter is created by git branch my\-B remote\-B (or its equivalent git checkout \-b my\-B remote\-B). Run git fetch to keep track of the progress of the remote side, and when you see something new on the remote branch, merge it into your development branch with git pull . remote\-B, while you are on my\-B branch.
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
index fc961bc9f8d4055bb4fff324116c523b22a53059..1afb01c73ead0fd152934524548e6d37d7a8cbfb 100644 (file)
@@ -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\-PULL" "1" "01/01/2007" "" ""
+.TH "GIT\-PULL" "1" "01/02/2007" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -48,7 +48,10 @@ Most of the tags are fetched automatically as branch heads are downloaded, but t
 Keep downloaded pack.
 .TP
 \-u, \-\-update\-head\-ok
-By default git\-fetch refuses to update the head which corresponds to the current branch. This flag disables the check. Note that fetching into the current branch will not update the index and working directory, so use it with care.
+By default git\-fetch refuses to update the head which corresponds to the current branch. This flag disables the check. This is purely for the internal use for git\-pull to communicate with git\-fetch, and unless you are implementing your own Porcelain you are not supposed to use it.
+.TP
+\-\-depth=<depth>
+Deepen the history of a \fIshallow\fR repository created by git clone with \-\-depth=<depth> option (see \fBgit\-clone\fR(1)) by the specified number of commits.
 .TP
 <repository>
 The "remote" repository that is the source of a fetch or pull operation. See the section GIT URLS below.
@@ -70,7 +73,7 @@ If the remote branch from which you want to pull is modified in non\-linear ways
 .nr an-break-flag 1
 .br
 \fBNote\fR
-You never do your own development on branches that appear on the right hand side of a <refspec> colon on Pull: lines; they are to be updated by git\-fetch. If you intend to do development derived from a remote branch B, have a Pull: line to track it (i.e. Pull: B:remote\-B), and have a separate branch my\-B to do your development on top of it. The latter is created by git branch my\-B remote\-B (or its equivalent git checkout \-b my\-B remote\-B). Run git fetch to keep track of the progress of the remote side, and when you see something new on the remote branch, merge it into your development branch with git pull . remote\-B, while you are on my\-B branch. The common Pull: master:origin mapping of a remote master branch to a local origin branch, which is then merged to a local development branch, again typically named master, is made when you run git clone for you to follow this pattern.
+You never do your own development on branches that appear on the right hand side of a <refspec> colon on Pull: lines; they are to be updated by git\-fetch. If you intend to do development derived from a remote branch B, have a Pull: line to track it (i.e. Pull: B:remote\-B), and have a separate branch my\-B to do your development on top of it. The latter is created by git branch my\-B remote\-B (or its equivalent git checkout \-b my\-B remote\-B). Run git fetch to keep track of the progress of the remote side, and when you see something new on the remote branch, merge it into your development branch with git pull . remote\-B, while you are on my\-B branch.
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@@ -179,14 +182,17 @@ This resolves any number of heads, but the result of the merge is always the cur
 .SH "EXAMPLES"
 .TP
 git pull, git pull origin
-Fetch the default head from the repository you cloned from and merge it into your current branch.
+Update the remote\-tracking branches for the repository you cloned from, then merge one of them into your current branch. Normally the branch merged in is the HEAD of the remote repository, but the choice is determined by the branch.<name>.remote and branch.<name>.merge options; see \fBgit\-repo\-config\fR(1) for details.
 .TP
-git pull \-s ours . obsolete
-Merge local branch obsolete into the current branch, using ours merge strategy.
+git pull origin next
+Merge into the current branch the remote branch next; leaves a copy of next temporarily in FETCH_HEAD, but does not update any remote\-tracking branches.
 .TP
 git pull . fixes enhancements
 Bundle local branch fixes and enhancements on top of the current branch, making an Octopus merge.
 .TP
+git pull \-s ours . obsolete
+Merge local branch obsolete into the current branch, using ours merge strategy.
+.TP
 git pull \-\-no\-commit . maint
 Merge local branch maint into the current branch, but do not make a commit automatically. This can be used when you want to include further changes to the merge, or want to write your own merge commit message.
 
@@ -195,33 +201,19 @@ You should refrain from abusing this option to sneak substantial changes into a
 Command line pull of multiple branches from one repository
 .sp
 .nf
-$ cat .git/remotes/origin
-URL: git://git.kernel.org/pub/scm/git/git.git
-Pull: master:origin
-
 $ git checkout master
-$ git fetch origin master:origin +pu:pu maint:maint
-$ git pull . origin
+$ git fetch origin +pu:pu maint:tmp
+$ git pull . tmp
 .fi
-Here, a typical .git/remotes/origin file from a git\-clone operation is used in combination with command line options to git\-fetch to first update multiple branches of the local repository and then to merge the remote origin branch into the local master branch. The local pu branch is updated even if it does not result in a fast forward update. Here, the pull can obtain its objects from the local repository using ., as the previous git\-fetch is known to have already obtained and made available all the necessary objects.
-.TP
-Pull of multiple branches from one repository using .git/remotes file
-.sp
-.nf
-$ cat .git/remotes/origin
-URL: git://git.kernel.org/pub/scm/git/git.git
-Pull: master:origin
-Pull: +pu:pu
-Pull: maint:maint
+This updates (or creates, as necessary) branches pu and tmp in the local repository by fetching from the branches (respectively) pu and maint from the remote repository.
 
-$ git checkout master
-$ git pull origin
-.fi
-Here, a typical .git/remotes/origin file from a git\-clone operation has been hand\-modified to include the branch\-mapping of additional remote and local heads directly. A single git\-pull operation while in the master branch will fetch multiple heads and merge the remote origin head into the current, local master branch.
+The pu branch will be updated even if it is does not fast\-forward; the others will not be.
+
+The final command then merges the newly fetched tmp into master.
 
 If you tried a pull which resulted in a complex conflicts and would want to start over, you can recover with \fBgit\-reset\fR(1).
 .SH "SEE ALSO"
-\fBgit\-fetch\fR(1), \fBgit\-merge\fR(1)
+\fBgit\-fetch\fR(1), \fBgit\-merge\fR(1), \fBgit\-repo\-config\fR(1)
 .SH "AUTHOR"
 Written by Linus Torvalds <torvalds@osdl.org> and Junio C Hamano <junkio@cox.net>
 .SH "DOCUMENTATION"