Autogenerated man pages for v1.3.2-g8611
authorJunio C Hamano <junio@hera.kernel.org>
Fri, 5 May 2006 23:15:06 +0000 (23:15 +0000)
committerJunio C Hamano <junio@hera.kernel.org>
Fri, 5 May 2006 23:15:06 +0000 (23:15 +0000)
20 files changed:
man1/git-add.1
man1/git-checkout-index.1
man1/git-cherry.1
man1/git-clone.1
man1/git-commit.1
man1/git-imap-send.1
man1/git-log.1
man1/git-ls-files.1
man1/git-merge-index.1
man1/git-name-rev.1
man1/git-prune.1
man1/git-repack.1
man1/git-repo-config.1
man1/git-reset.1
man1/git-rm.1
man1/git-unpack-objects.1
man1/git-update-index.1
man1/git-verify-pack.1
man1/git-whatchanged.1
man1/gitk.1

index 731b9092f76419c2953447435cd44419cf6cd8cd..d95c02db40acce1e91d9c057b6996d556cd7cd04 100755 (executable)
@@ -45,7 +45,7 @@ Don't actually add the file(s), just show if they exist\&.
 Be verbose\&.
 
 .TP
---
+\-\-
 This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&.
 
 .SH "DISCUSSION"
index 1a21600170371bc5f0e8466492642289c963b96b..a2398a6fad515bfb2576409dc536253bde677350 100755 (executable)
@@ -78,7 +78,7 @@ Instead of taking list of paths from the command line, read list of paths from t
 Only meaningful with \-\-stdin; paths are separated with NUL character instead of LF\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 
index e8b8d509c41e4923fcee9c0273118ad2f62fe089..8d7eb96f9f27ea4aceaa4910077a9f99163f248e 100755 (executable)
@@ -28,7 +28,13 @@ git-cherry \- Find commits not merged upstream
 .SH "DESCRIPTION"
 
 
-Each commit between the fork\-point and <head> is examined, and compared against the change each commit between the fork\-point and <upstream> introduces\&. Commits already included in upstream are prefixed with \fI\-\fR (meaning "drop from my local pull"), while commits missing from upstream are prefixed with \fI+\fR (meaning "add to the updated upstream")\&.
+The changeset (or "diff") of each commit between the fork\-point and <head> is compared against each commit between the fork\-point and <upstream>\&.
+
+
+Every commit with a changeset that doesn't exist in the other branch has its id (sha1) reported, prefixed by a symbol\&. Those existing only in the <upstream> branch are prefixed with a minus (\-) sign, and those that only exist in the <head> branch are prefixed with a plus (+) symbol\&.
+
+
+Because git\-cherry compares the changeset rather than the commit id (sha1), you can use git\-cherry to find out if a commit you made locally has been applied <upstream> under a different commit id\&. For example, this will happen if you're feeding patches <upstream> via email rather than pushing or pulling commits directly\&.
 
 .SH "OPTIONS"
 
index d43b3ba1ca864c0144d2d5d3c0dc1439751ba0d5..772f953e4b925e16b6464db25dcd695b1fabeff6 100755 (executable)
@@ -85,7 +85,7 @@ The (possibly remote) repository to clone from\&. It can be any URL git\-fetch s
 <directory>
 The name of a new directory to clone into\&. The "humanish" part of the source repository is used if no directory is explicitly given ("repo" for "/path/to/repo\&.git" and "foo" for "host\&.xz:foo/\&.git")\&. Cloning into an existing directory is not allowed\&.
 
-.SS "Examples"
+.SH "EXAMPLES"
 
 .TP
 Clone from upstream
index 9cf30eda366d855e8259cfffb22cd8e633a578eb..7faec2341506c6b995cf257b485d15f58199502d 100755 (executable)
@@ -101,7 +101,7 @@ Instead of committing only the files specified on the command line, update them
 Commit only the files specified on the command line\&. This format cannot be used during a merge, nor when the index and the latest commit does not match on the specified paths to avoid confusion\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP
index b39bf3107cb375006023f6c86bdfa99ae3b2bdb8..479bf1144fda281d12cf238e59c5f069abea7620 100755 (executable)
@@ -42,18 +42,17 @@ git\-format\-patch \-\-signoff \-\-stdout \-\-attach origin | git\-imap\-send
 git\-imap\-send requires the following values in the repository configuration file (shown with examples):
 
 .nf
-Folder = "INBOX\&.Drafts"
-.fi
+[imap]
+    Folder = "INBOX\&.Drafts"
 
-.nf
-Tunnel = "ssh \-q user@server\&.com /usr/bin/imapd \&./Maildir 2> /dev/null"
-.fi
+[imap]
+    Tunnel = "ssh \-q user@server\&.com /usr/bin/imapd \&./Maildir 2> /dev/null"
 
-.nf
-Host = imap\&.server\&.com
-User = bob
-Password = pwd
-Port = 143
+[imap]
+    Host = imap\&.server\&.com
+    User = bob
+    Pass = pwd
+    Port = 143
 .fi
 
 .SH "BUGS"
index 530c27220396cddff13d1972087a654b8e0bffb1..d7164cd872623bb675382dc16c83160bc8264319 100755 (executable)
@@ -69,7 +69,7 @@ git log v2\&.6\&.12\&.\&. include/scsi drivers/scsi
 Show all commits since version \fIv2\&.6\&.12\fR that changed any file in the include/scsi or drivers/scsi subdirectories
 
 .TP
-git log \-\-since="2 weeks ago" -- gitk
+git log \-\-since="2 weeks ago" \-\- gitk
 Show the changes during the last two weeks to the file \fIgitk\fR\&. The "\-\-" is necessary to avoid confusion with the \fIbranch\fR named \fIgitk\fR 
 
 .TP
index e62f3a0220449dd7e6cd6fd2c3e9620729e0117c..efe6af5c502e12f3cb69a1314874d9e6e1f570e2 100755 (executable)
@@ -144,7 +144,7 @@ When run from a subdirectory, the command usually outputs paths relative to the
 Instead of showing the full 40\-byte hexadecimal object lines, show only handful hexdigits prefix\&. Non default number of digits can be specified with \-\-abbrev=<n>\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP
index 5d68938a351572c70291152b3888a70b5359405b..7bef26b7a786c7f9b3b7aa1d0e5d846b06eeb184 100755 (executable)
@@ -23,7 +23,7 @@ git-merge-index \- Runs a merge for files needing merging
 .SH "SYNOPSIS"
 
 
-git\-merge\-index [\-o] [\-q] <merge\-program> (\-a | -- | <file>*)
+\fIgit\-merge\-index\fR [\-o] [\-q] <merge\-program> (\-a | \-\- | <file>*)
 
 .SH "DESCRIPTION"
 
@@ -33,7 +33,7 @@ This looks up the <file>(s) in the index and, if there are any merge entries, pa
 .SH "OPTIONS"
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP
index 6c47b98441104d3931a9375ff4560b860f27f0e6..a3613d210d35e1ffe31f717b174b5ddcea36cc3c 100755 (executable)
@@ -54,6 +54,7 @@ Enter git\-name\-rev:
 
 .nf
 % git name\-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
+33db5f4d9027a10e477ccf054b2c1ab94f74c85a tags/v0\&.99^0~940
 .fi
 
 
index a3abd84fc88536328739bc490a652bfebb891afd..7d1703198b3e7a22cb157c2c15e25459ade0e446 100755 (executable)
@@ -23,7 +23,7 @@ git-prune \- Prunes all unreachable objects from the object database
 .SH "SYNOPSIS"
 
 
-git\-prune [\-n] [\-\-] [<head>...]
+\fIgit\-prune\fR [\-n] [\-\-] [<head>...]
 
 .SH "DESCRIPTION"
 
@@ -37,7 +37,7 @@ This runs git\-fsck\-objects \-\-unreachable using all the refs available in $GI
 Do not remove anything; just report what it would remove\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP
@@ -49,8 +49,10 @@ In addition to objects reachable from any of our references, keep objects reacha
 
 To prune objects not used by your repository nor another that borrows from your repository via its \&.git/objects/info/alternates:
 
-.IP
+.nf
 $ git prune $(cd \&.\&./another && $(git\-rev\-parse \-\-all))
+.fi
+
 .SH "AUTHOR"
 
 
index edf251721b7fefa727e5bc24bdf5a4272704478e..bbe8c4a0bca0461d8f355370fdf7e0004ac5d340 100755 (executable)
@@ -44,7 +44,7 @@ Instead of incrementally packing the unpacked objects, pack everything available
 
 .TP
 \-d
-After packing, if the newly created packs make some existing packs redundant, remove the redundant packs\&.
+After packing, if the newly created packs make some existing packs redundant, remove the redundant packs\&. Also runs \fBgit\-prune\-packed\fR(1)\&.
 
 .TP
 \-l
index ef6dfb5f4975622bd4c92ede97fc4e7becc0a894..07508510435b2c5195df80a06def383db0799b79 100755 (executable)
@@ -44,14 +44,14 @@ If you want to set/unset an option which can occur on multiple lines, you should
 The type specifier can be either \fI\-\-int\fR or \fI\-\-bool\fR, which will make \fIgit\-repo\-config\fR ensure that the variable(s) are of the given type and convert the value to the canonical form (simple decimal number for int, a "true" or "false" string for bool)\&. If no type specifier is passed, no checks or transformations are performed on the value\&.
 
 
-This command will fail if
+This command will fail if:
 
 .TP 3
 1.
-\&.git/config is invalid,
+The \&.git/config file is invalid,
 .TP
 2.
-\&.git/config can not be written to,
+Can not write to \&.git/config,
 .TP
 3.
 no section was provided,
index bfa0082fd8817726a22f7cfffdd61cd70ed80797..eccf1fac6bfc6cae61ae3a7b1aae3eb3c2d0774b 100755 (executable)
@@ -54,7 +54,7 @@ Matches the working tree and index to that of the tree being switched to\&. Any
 <commit\-ish>
 Commit to make the current HEAD\&.
 
-.SS "Examples"
+.SH "EXAMPLES"
 
 .TP
 Undo a commit and redo
index fa3c0849f8cb97f2c4d9c4398f2b286622ec0b6e..9668ff245710a07e7e2f66923088eb8d66bc4548 100755 (executable)
@@ -49,7 +49,7 @@ Don't actually remove the file(s), just show if they exist in the index\&.
 Be verbose\&.
 
 .TP
---
+\-\-
 This option can be used to separate command\-line options from the list of files, (useful when filenames might be mistaken for command\-line options)\&.
 
 .SH "DISCUSSION"
index 13a6710163af1dfd2a5a735f93c0b0a97d01eb6b..237adfa45e557d7410ed214aea4be1f891fb243c 100755 (executable)
@@ -28,7 +28,13 @@ git-unpack-objects \- Unpack objects from a packed archive
 .SH "DESCRIPTION"
 
 
-Reads a packed archive (\&.pack) from the standard input, and expands the objects contained in the pack into "one\-file one\-object" format in $GIT_OBJECT_DIRECTORY\&.
+Read a packed archive (\&.pack) from the standard input, expanding the objects contained within and writing them into the repository in "loose" (one object per file) format\&.
+
+
+Objects that already exist in the repository will \fInot\fR be unpacked from the pack\-file\&. Therefore, nothing will be unpacked if you use this command on a pack\-file that exists within the target repository\&.
+
+
+Please see the git\-repack documentation for options to generate new packs and replace existing ones\&.
 
 .SH "OPTIONS"
 
index cdde330666cd68b07407bdd2598903f28fa3d609..10a1d1f417cea37efacfac0364696ae0c4b6592a 100755 (executable)
@@ -115,7 +115,7 @@ Report what is being added and removed from index\&.
 Only meaningful with \-\-stdin; paths are separated with NUL character instead of LF\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .TP
index 2a1995116dd2c773118775762296aa78ea827465..beb003ed3b195a8e514c1ea7bd66d05caf32ff42 100755 (executable)
@@ -41,7 +41,7 @@ The idx files to verify\&.
 After verifying the pack, show list of objects contained in the pack\&.
 
 .TP
---
+\-\-
 Do not interpret any more arguments as options\&.
 
 .SH "OUTPUT FORMAT"
index ee7aa03cf064182fa2a71d08b60d676d40002601..7ec2674a39350007ef5f68f372a387621a0d9792 100755 (executable)
@@ -68,7 +68,7 @@ git\-whatchanged \-p v2\&.6\&.12\&.\&. include/scsi drivers/scsi
 Show as patches the commits since version \fIv2\&.6\&.12\fR that changed any file in the include/scsi or drivers/scsi subdirectories
 
 .TP
-git\-whatchanged \-\-since="2 weeks ago" -- gitk
+git\-whatchanged \-\-since="2 weeks ago" \-\- gitk
 Show the changes during the last two weeks to the file \fIgitk\fR\&. The "\-\-" is necessary to avoid confusion with the \fIbranch\fR named \fIgitk\fR 
 
 .SH "AUTHOR"
index 2e3aabb0b96212169f8cc495a6efc1d09b28a758..49e49766874eba8a1f933184fec02dcd24a070a3 100755 (executable)
@@ -23,7 +23,7 @@ gitk \- Some git command not yet documented.
 .SH "SYNOPSIS"
 
 
-gitk [ \-\-option ] <args>...
+\fIgitk\fR [ \-\-option ] <args>...
 
 .SH "DESCRIPTION"
 
@@ -44,11 +44,11 @@ Some argument not yet documented\&.
 
 .TP
 gitk v2\&.6\&.12\&.\&. include/scsi drivers/scsi
-Show as the changes since version v2\&.6\&.12 that changed any file in the include/scsi or drivers/scsi subdirectories
+Show as the changes since version \fIv2\&.6\&.12\fR that changed any file in the include/scsi or drivers/scsi subdirectories
 
 .TP
-gitk \-\-since="2 weeks ago" -- gitk
-Show the changes during the last two weeks to the file gitk\&. The "\-\-" is necessary to avoid confusion with the branch named gitk 
+gitk \-\-since="2 weeks ago" \-\- gitk
+Show the changes during the last two weeks to the file \fIgitk\fR\&. The "\-\-" is necessary to avoid confusion with the \fIbranch\fR named \fIgitk\fR 
 
 .SH "AUTHOR"