From a6979d5d0d613f59cbc91810be57210d5e6d5f88 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 7 Jun 2006 19:52:09 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.0-rc1-gfd7e --- man1/git-apply.1 | 2 +- man1/git-check-ref-format.1 | 2 +- man1/git-describe.1 | 2 +- man1/git-ls-tree.1 | 14 ++++++---- man1/git-name-rev.1 | 2 +- man1/git-p4import.1 | 2 +- man1/git-read-tree.1 | 2 +- man1/git-repo-config.1 | 10 +++++-- man1/git-shortlog.1 | 17 ++++++++++- man1/git-tar-tree.1 | 36 +++++++++++++++++++++++- man1/git-upload-tar.1 | 56 +++++++++++++++++++++++++++++++++++++ man7/git.7 | 11 ++++++++ 12 files changed, 140 insertions(+), 16 deletions(-) create mode 100755 man1/git-upload-tar.1 diff --git a/man1/git-apply.1 b/man1/git-apply.1 index fd3db6531..fbe9a19bf 100755 --- a/man1/git-apply.1 +++ b/man1/git-apply.1 @@ -74,7 +74,7 @@ Remove leading slashes from traditional diff paths\&. The default is 1\&. .TP \-C -Ensure at least lines of surrounding context match before and after each change\&. When fewer lines of surrounding context exist they all most match\&. By default no context is ever ignored\&. +Ensure at least lines of surrounding context match before and after each change\&. When fewer lines of surrounding context exist they all must match\&. By default no context is ever ignored\&. .TP \-\-apply diff --git a/man1/git-check-ref-format.1 b/man1/git-check-ref-format.1 index ef77de027..ff6111195 100755 --- a/man1/git-check-ref-format.1 +++ b/man1/git-check-ref-format.1 @@ -35,7 +35,7 @@ A reference is used in git to specify branches and tags\&. A branch head is stor .TP 3 1. -It could be named hierarchically (i\&.e\&. separated with slash /), but each of its component cannot begin with a dot \&.; +It can include slash / for hierarchical (directory) grouping, but no slash\-separated component can begin with a dot \&.; .TP 2. It cannot have two consecutive dots \&.\&. anywhere; diff --git a/man1/git-describe.1 b/man1/git-describe.1 index 36c797bf0..8c262fca4 100755 --- a/man1/git-describe.1 +++ b/man1/git-describe.1 @@ -34,7 +34,7 @@ The command finds the most recent tag that is reachable from a commit, and if th .TP -The object name of the comittish\&. +The object name of the committish\&. .TP \-\-all diff --git a/man1/git-ls-tree.1 b/man1/git-ls-tree.1 index 7d6177846..3ba2293c5 100755 --- a/man1/git-ls-tree.1 +++ b/man1/git-ls-tree.1 @@ -22,8 +22,11 @@ git-ls-tree \- Lists the contents of a tree object .SH "SYNOPSIS" - -\fIgit\-ls\-tree\fR [\-d] [\-r] [\-t] [\-z] [\-\-name\-only] [\-\-name\-status] [\-\-full\-name] [\-\-abbrev=[]] [paths...] +.nf +\fIgit\-ls\-tree\fR [\-d] [\-r] [\-t] [\-z] + [\-\-name\-only] [\-\-name\-status] [\-\-full\-name] [\-\-abbrev=[]] + [paths...] +.fi .SH "DESCRIPTION" @@ -60,6 +63,10 @@ List only filenames (instead of the "long" output), one per line\&. \-\-abbrev[=] 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=\&. +.TP +\-\-full\-name +Instead of showing the path names relative the current working directory, show the full path names\&. + .TP paths When paths are given, show them (note that this isn't really raw pathnames, but rather a list of patterns to match)\&. Otherwise implicitly uses the root level of the tree as the sole path argument\&. @@ -83,9 +90,6 @@ Written by Petr Baudis Completely rewritten from scratch by Ju Documentation by David Greaves, Junio C Hamano and the git\-list \&. - -This manual page is a stub\&. You can help the git documentation by expanding it\&. - .SH "GIT" diff --git a/man1/git-name-rev.1 b/man1/git-name-rev.1 index a3613d210..2d178a22a 100755 --- a/man1/git-name-rev.1 +++ b/man1/git-name-rev.1 @@ -23,7 +23,7 @@ git-name-rev \- Find symbolic names for given revs .SH "SYNOPSIS" -\fIgit\-name\-rev\fR [\-\-tags] ( \-\-all | \-\-stdin | ... ) +\fIgit\-name\-rev\fR [\-\-tags] ( \-\-all | \-\-stdin | ... ) .SH "DESCRIPTION" diff --git a/man1/git-p4import.1 b/man1/git-p4import.1 index 09921449f..0f5256c9f 100755 --- a/man1/git-p4import.1 +++ b/man1/git-p4import.1 @@ -129,7 +129,7 @@ Another option is to create multiple symlinks locally which all point to the sam A git tag of the form p4/xx is created for every change imported from the Perforce repository where xx is the Perforce changeset number\&. Therefore after the import you can use git to access any commit by its Perforce number, eg\&. git show p4/327\&. -The tag associated with the HEAD commit is also how git\-p4import determines if their are new changes to incrementally import from the Perforce repository\&. +The tag associated with the HEAD commit is also how git\-p4import determines if there are new changes to incrementally import from the Perforce repository\&. If you import from a repository with many thousands of changes you will have an equal number of p4/xxxx git tags\&. Git tags can be expensive in terms of disk space and repository operations\&. If you don't need to perform further incremental imports, you may delete the tags\&. diff --git a/man1/git-read-tree.1 b/man1/git-read-tree.1 index c3662f545..0fedb5c21 100755 --- a/man1/git-read-tree.1 +++ b/man1/git-read-tree.1 @@ -238,7 +238,7 @@ You would normally use git\-merge\-index with supplied git\-merge\-one\-file to When you start a 3\-way merge with an index file that is already populated, it is assumed that it represents the state of the files in your work tree, and you can even have files with changes unrecorded in the index file\&. It is further assumed that this state is "derived" from the stage 2 tree\&. The 3\-way merge refuses to run if it finds an entry in the original index file that does not match stage 2\&. -This is done to prevent you from losing your work\-in\-progress changes, and mixing your random changes in an unrelated merge commit\&. To illustrate, suppose you start from what has been commited last to your repository: +This is done to prevent you from losing your work\-in\-progress changes, and mixing your random changes in an unrelated merge commit\&. To illustrate, suppose you start from what has been committed last to your repository: .nf $ JC=`git\-rev\-parse \-\-verify "HEAD^0"` diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index a3bdc4e20..c8c219d7a 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.1 @@ -275,6 +275,10 @@ If true, the repository is made shareable between several users in a group (maki core\&.warnAmbiguousRefs If true, git will warn you if the ref name you passed it is ambiguous and might match multiple refs in the \&.git/refs/ tree\&. True by default\&. +.TP +alias\&.* +Command aliases for the \fBgit\fR(1) command wrapper \- e\&.g\&. after defining "alias\&.last = cat\-file commit HEAD", the invocation "git last" is equivalent to "git cat\-file commit HEAD"\&. To avoid confusion, aliases that hide existing git commands are ignored\&. Arguments are split at whitespaces, but single or double quote pair can be used to quote them\&. + .TP apply\&.whitespace Tells git\-apply how to handle whitespaces, in the same way as the \fI\-\-whitespace\fR option\&. See \fBgit\-apply\fR(1)\&. @@ -297,11 +301,11 @@ Path to a log file where the cvs pserver interface well... logs various stuff\&. .TP http\&.sslVerify -Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_NO_VERIFY\fR environment variable\&. +Whether to verify the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_NO_VERIFY\fR environment variable\&. .TP http\&.sslCert -File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_CERT\fR environment variable\&. +File containing the SSL certificate when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CERT\fR environment variable\&. .TP http\&.sslKey @@ -313,7 +317,7 @@ File containing the certificates to verify the peer with when fetching or pushin .TP http\&.sslCAPath -Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overriden by the \fIGIT_SSL_CAPATH\fR environment variable\&. +Path containing files with the CA certificates to verify the peer with when fetching or pushing over HTTPS\&. Can be overridden by the \fIGIT_SSL_CAPATH\fR environment variable\&. .TP http\&.maxRequests diff --git a/man1/git-shortlog.1 b/man1/git-shortlog.1 index dc3057893..360ac390e 100755 --- a/man1/git-shortlog.1 +++ b/man1/git-shortlog.1 @@ -28,7 +28,22 @@ git\-log \-\-pretty=short | \fIgit\-shortlog\fR .SH "DESCRIPTION" -Summarizes \fIgit log\fR output in a format suitable for inclusion in release announcements\&. +Summarizes \fIgit log\fR output in a format suitable for inclusion in release announcements\&. Each commit will be grouped by author the first line of the commit message will be shown\&. + + +Additionally, "[PATCH]" will be stripped from the commit description\&. + +.SH "FILES" + +.TP +\fI\&.mailmap\fR +If this file exists, it will be used for mapping author email addresses to a real author name\&. One mapping per line, first the author name followed by the email address enclosed by \fI<\fR and \fI>\fR\&. Use hash \fI#\fR for comments\&. Example: + +.nf +# Keep alphabetized +Adam Morrow +Eve Jones +.fi .SH "AUTHOR" diff --git a/man1/git-tar-tree.1 b/man1/git-tar-tree.1 index 8e9f62907..4c1789528 100755 --- a/man1/git-tar-tree.1 +++ b/man1/git-tar-tree.1 @@ -23,7 +23,7 @@ git-tar-tree \- Creates a tar archive of the files in the named tree .SH "SYNOPSIS" -git\-tar\-tree [ ] +\fIgit\-tar\-tree\fR [\-\-remote=] [ ] .SH "DESCRIPTION" @@ -33,6 +33,40 @@ Creates a tar archive containing the tree structure for the named tree\&. When < git\-tar\-tree behaves differently when given a tree ID versus when given a commit ID or tag ID\&. In the first case the current time is used as modification time of each file in the archive\&. In the latter case the commit time as recorded in the referenced commit object is used instead\&. Additionally the commit ID is stored in a global extended pax header\&. It can be extracted using git\-get\-tar\-commit\-id\&. +.SH "OPTIONS" + +.TP + +The tree or commit to produce tar archive for\&. If it is the object name of a commit object\&. + +.TP + +Leading path to the files in the resulting tar archive\&. + +.TP +\-\-remote= +Instead of making a tar archive from local repository, retrieve a tar archive from a remote repository\&. + +.SH "EXAMPLES" + +.TP +git tar\-tree HEAD | (cd /var/tmp/ && mkdir junk && tar Cxf junk \-) +Create a tar archive that contains the contents of the latest commit on the current branch, and extracts it in /var/tmp/junk directory\&. + + +git tar\-tree v2\&.6\&.17 linux\-2\&.6\&.17 | gzip >linux\-2\&.6\&.17\&.tar\&.gz + +.nf +Create a tarball for v2\&.6\&.17 release\&. +.fi + + +git tar\-tree \-\-remote=example\&.com:git\&.git v0\&.99 >git\-0\&.99\&.tar + +.nf +Get a tarball v0\&.99 from example\&.com\&. +.fi + .SH "AUTHOR" diff --git a/man1/git-upload-tar.1 b/man1/git-upload-tar.1 new file mode 100755 index 000000000..872c8874a --- /dev/null +++ b/man1/git-upload-tar.1 @@ -0,0 +1,56 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "GIT-UPLOAD-TAR" 1 "" "" "" +.SH NAME +git-upload-tar \- Send tar archive +.SH "SYNOPSIS" + + +\fIgit\-upload\-tar\fR + +.SH "DESCRIPTION" + + +Invoked by \fIgit\-tar\-tree \-\-remote\fR and sends a generated tar archive to the other end over the git protocol\&. + + +This command is usually not invoked directly by the end user\&. The UI for the protocol is on the \fIgit\-tar\-tree\fR side, and the program pair is meant to be used to get a tar achive from a remote repository\&. + +.SH "OPTIONS" + +.TP + +The repository to get a tar archive from\&. + +.SH "AUTHOR" + + +Written by Junio C Hamano + +.SH "DOCUMENTATION" + + +Documentation by Junio C Hamano\&. + +.SH "GIT" + + +Part of the \fBgit\fR(7) suite + diff --git a/man7/git.7 b/man7/git.7 index ef4c67a1c..34c0b6adc 100755 --- a/man7/git.7 +++ b/man7/git.7 @@ -33,6 +33,9 @@ Git is a fast, scalable, distributed revision control system with an unusually r See this tutorial: \fItutorial.html\fR to get started, then see Everyday Git: \fIeveryday.html\fR for a useful minimum set of commands, and "man git\-commandname" for documentation of each command\&. CVS users may also want to read CVS migration: \fIcvs-migration.html\fR\&. + +The COMMAND is either a name of a Git command (see below) or an alias as defined in the configuration file (see \fBgit\-repo\-config\fR(1))\&. + .SH "OPTIONS" .TP @@ -268,6 +271,10 @@ Updates auxiliary information on a dumb server to help clients discover referenc \fBgit\-upload\-pack\fR(1) Invoked by \fIgit\-clone\-pack\fR and \fIgit\-fetch\-pack\fR to push what are asked for\&. +.TP +\fBgit\-upload\-tar\fR(1) +Invoked by \fIgit\-tar\-tree \-\-remote\fR to return the tar archive the other end asked for\&. + .SH "HIGH-LEVEL COMMANDS (PORCELAIN)" @@ -448,6 +455,10 @@ The standard helper program to use with git\-merge\-index\&. \fBgit\-prune\fR(1) Prunes all unreachable objects from the object database\&. +.TP +\fBgit\-quiltimport\fR(1) +Applies a quilt patchset onto the current branch\&. + .TP \fBgit\-relink\fR(1) Hardlink common objects in local repositories\&. -- 2.26.2