From 0af592f99a241a6bd34ad555d4517fb07fc43aeb Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Wed, 17 Jan 2007 23:28:03 +0000 Subject: [PATCH] Autogenerated man pages for v1.5.0-rc1-gde38 --- man1/git-applypatch.1 | 11 ++++------- man1/git-blame.1 | 3 ++- man1/git-commit-tree.1 | 4 +++- man1/git-fetch-pack.1 | 29 +++++++++-------------------- man1/git-mailinfo.1 | 4 ++-- man1/git-parse-remote.1 | 33 ++++++--------------------------- man1/git-resolve.1 | 12 +++++------- man1/git-send-pack.1 | 32 ++++++++++++-------------------- 8 files changed, 43 insertions(+), 85 deletions(-) diff --git a/man1/git-applypatch.1 b/man1/git-applypatch.1 index 4030ad9aa..76e0358e8 100644 --- a/man1/git-applypatch.1 +++ b/man1/git-applypatch.1 @@ -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\-APPLYPATCH" "1" "10/03/2006" "" "" +.TH "GIT\-APPLYPATCH" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,12 +11,12 @@ git\-applypatch \- Apply one patch extracted from an e\-mail .SH "SYNOPSIS" \fIgit\-applypatch\fR [] -.sp .SH "DESCRIPTION" +This is usually not what an end user wants to run directly. See \fBgit\-am\fR(1) instead. + Takes three files , , and prepared from an e\-mail message by \fIgit\-mailinfo\fR, and creates a commit. It is usually not necessary to use this command directly. -.sp + This command can run applypatch\-msg, pre\-applypatch, and post\-applypatch hooks. See [1]\&\fIhooks\fR for more information. -.sp .SH "OPTIONS" .TP @@ -29,13 +29,10 @@ The patch to apply. Author and subject information extracted from e\-mail, used on "author" line and as the first line of the commit log message. .SH "AUTHOR" Written by Linus Torvalds -.sp .SH "DOCUMENTATION" Documentation by Junio C Hamano and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp .SH "REFERENCES" .TP 3 1.\ hooks diff --git a/man1/git-blame.1 b/man1/git-blame.1 index cc43bac12..6d6a25645 100644 --- a/man1/git-blame.1 +++ b/man1/git-blame.1 @@ -91,10 +91,11 @@ the first line of the commit log message ("summary"). The contents of the actual line is output after the above header, prefixed by a TAB. This is to allow adding more header elements later. .SH "SPECIFYING RANGES" -Unlike git\-blame and git\-annotate in older git, the extent of annotation can be limited to both line ranges and revision ranges. When you are interested in finding the origin for ll. 40\-60 for file foo, you can use \-L option like this: +Unlike git\-blame and git\-annotate in older git, the extent of annotation can be limited to both line ranges and revision ranges. When you are interested in finding the origin for ll. 40\-60 for file foo, you can use \-L option like these (they mean the same thing \(em both ask for 21 lines starting at line 40): .sp .nf git blame \-L 40,60 foo +git blame \-L 40,+21 foo .fi Also you can use regular expression to specify the line range. .sp diff --git a/man1/git-commit-tree.1 b/man1/git-commit-tree.1 index 66923caa4..684383ad5 100644 --- a/man1/git-commit-tree.1 +++ b/man1/git-commit-tree.1 @@ -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\-COMMIT\-TREE" "1" "12/31/2006" "" "" +.TH "GIT\-COMMIT\-TREE" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,6 +12,8 @@ git\-commit\-tree \- Creates a new commit object .SH "SYNOPSIS" \fIgit\-commit\-tree\fR [\-p ]* < changelog .SH "DESCRIPTION" +This is usually not what an end user wants to run directly. See \fBgit\-commit\fR(1) instead. + Creates a new commit object based on the provided tree object and emits the new commit object id on stdout. If no parent is given then it is considered to be an initial tree. A commit object usually has 1 parent (a commit after a change) or up to 16 parents. More than one parent represents a merge of branches that led to them. diff --git a/man1/git-fetch-pack.1 b/man1/git-fetch-pack.1 index 8c6ea8e82..f84e8c52e 100644 --- a/man1/git-fetch-pack.1 +++ b/man1/git-fetch-pack.1 @@ -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\-PACK" "1" "11/08/2006" "" "" +.TH "GIT\-FETCH\-PACK" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,34 +11,25 @@ git\-fetch\-pack \- Receive missing objects from another repository .SH "SYNOPSIS" \fIgit\-fetch\-pack\fR [\-q] [\-k] [\-\-exec=] [:] [\&...] -.sp .SH "DESCRIPTION" +Usually you would want to use \fBgit\-fetch\fR(1) which is a higher level wrapper of this command instead. + Invokes \fIgit\-upload\-pack\fR on a potentially remote repository, and asks it to send objects missing from this repository, to update the named heads. The list of commits available locally is found out by scanning local $GIT_DIR/refs/ and sent to \fIgit\-upload\-pack\fR running on the other end. -.sp + This command degenerates to download everything to complete the asked refs from the remote side when the local side does not have a common ancestor commit. -.sp .SH "OPTIONS" .TP \-q -Pass -\fI\-q\fR -flag to -\fIgit\-unpack\-objects\fR; this makes the cloning process less verbose. +Pass \fI\-q\fR flag to \fIgit\-unpack\-objects\fR; this makes the cloning process less verbose. .TP \-k -Do not invoke -\fIgit\-unpack\-objects\fR -on received data, but create a single packfile out of it instead, and store it in the object database. If provided twice then the pack is locked against repacking. +Do not invoke \fIgit\-unpack\-objects\fR on received data, but create a single packfile out of it instead, and store it in the object database. If provided twice then the pack is locked against repacking. .TP \-\-exec= -Use this to specify the path to -\fIgit\-upload\-pack\fR -on the remote side, if is not found on your $PATH. Installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system default $PATH. Another workaround suggested is to set up your $PATH in ".bashrc", but this flag is for people who do not want to pay the overhead for non\-interactive shells by having a lean .bashrc file (they set most of the things up in .bash_profile). +Use this to specify the path to \fIgit\-upload\-pack\fR on the remote side, if is not found on your $PATH. Installations of sshd ignores the user's environment setup scripts for login shells (e.g. .bash_profile) and your privately installed git may not be found on the system default $PATH. Another workaround suggested is to set up your $PATH in ".bashrc", but this flag is for people who do not want to pay the overhead for non\-interactive shells by having a lean .bashrc file (they set most of the things up in .bash_profile). .TP -A remote host that houses the repository. When this part is specified, -\fIgit\-upload\-pack\fR -is invoked via ssh. +A remote host that houses the repository. When this part is specified, \fIgit\-upload\-pack\fR is invoked via ssh. .TP The repository to sync from. @@ -47,10 +38,8 @@ The repository to sync from. The remote heads to update from. This is relative to $GIT_DIR (e.g. "HEAD", "refs/heads/master"). When unspecified, update from all heads the remote side has. .SH "AUTHOR" Written by Linus Torvalds -.sp .SH "DOCUMENTATION" Documentation by Junio C Hamano. -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-mailinfo.1 b/man1/git-mailinfo.1 index 7c5b4e236..51f6bcb78 100644 --- a/man1/git-mailinfo.1 +++ b/man1/git-mailinfo.1 @@ -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\-MAILINFO" "1" "01/10/2007" "" "" +.TH "GIT\-MAILINFO" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -12,7 +12,7 @@ git\-mailinfo \- Extracts patch from a single e\-mail message .SH "SYNOPSIS" \fIgit\-mailinfo\fR [\-k] [\-u | \-\-encoding=] .SH "DESCRIPTION" -Reading a single e\-mail message from the standard input, and writes the commit log message in file, and the patches in file. The author name, e\-mail and e\-mail subject are written out to the standard output to be used by git\-applypatch to create a commit. It is usually not necessary to use this command directly. +Reading a single e\-mail message from the standard input, and writes the commit log message in file, and the patches in file. The author name, e\-mail and e\-mail subject are written out to the standard output to be used by git\-applypatch to create a commit. It is usually not necessary to use this command directly. See \fBgit\-am\fR(1) instead. .SH "OPTIONS" .TP \-k diff --git a/man1/git-parse-remote.1 b/man1/git-parse-remote.1 index 5c048affb..066e9423a 100644 --- a/man1/git-parse-remote.1 +++ b/man1/git-parse-remote.1 @@ -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\-PARSE\-REMOTE" "1" "10/03/2006" "" "" +.TH "GIT\-PARSE\-REMOTE" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,41 +11,20 @@ git\-parse\-remote \- Routines to help parsing $GIT_DIR/remotes/ .SH "SYNOPSIS" \fI. git\-parse\-remote\fR -.sp .SH "DESCRIPTION" -This script is included in various scripts to supply routines to parse files under $GIT_DIR/remotes/ and $GIT_DIR/branches/. -.sp +This script is included in various scripts to supply routines to parse files under $GIT_DIR/remotes/ and $GIT_DIR/branches/ and configuration variables that are related to fetching, pulling and pushing. + The primary entry points are: -.sp .TP get_remote_refs_for_fetch -Given the list of user\-supplied - \&..., return the list of refs to fetch after canonicalizing them into -$GIT_DIR -relative paths (e.g. -refs/heads/foo). When -\&... -is empty the returned list of refs consists of the defaults for the given -, if specified in -$GIT_DIR/remotes/ -or -$GIT_DIR/branches/. +Given the list of user\-supplied \&..., return the list of refs to fetch after canonicalizing them into $GIT_DIR relative paths (e.g. refs/heads/foo). When \&... is empty the returned list of refs consists of the defaults for the given , if specified in $GIT_DIR/remotes/, $GIT_DIR/branches/, or remote.*.fetch configuration. .TP get_remote_refs_for_push -Given the list of user\-supplied - \&..., return the list of refs to push in a form suitable to be fed to the -git\-send\-pack -command. When -\&... -is empty the returned list of refs consists of the defaults for the given -, if specified in -$GIT_DIR/remotes/. +Given the list of user\-supplied \&..., return the list of refs to push in a form suitable to be fed to the git\-send\-pack command. When \&... is empty the returned list of refs consists of the defaults for the given , if specified in $GIT_DIR/remotes/. .SH "AUTHOR" Written by Junio C Hamano. -.sp .SH "DOCUMENTATION" Documentation by Junio C Hamano and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-resolve.1 b/man1/git-resolve.1 index da556411c..8f0787ad5 100644 --- a/man1/git-resolve.1 +++ b/man1/git-resolve.1 @@ -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\-RESOLVE" "1" "10/03/2006" "" "" +.TH "GIT\-RESOLVE" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,18 +11,16 @@ git\-resolve \- Merge two commits .SH "SYNOPSIS" \fIgit\-resolve\fR -.sp .SH "DESCRIPTION" +DEPRECATED. Use git\-merge instead. + Given two commits and a merge message, merge the commit into commit, with the commit log message . -.sp + When is a descendant of , or is an ancestor of , no new commit is created and the is ignored. The former is informally called "already up to date", and the latter is often called "fast forward". -.sp .SH "AUTHOR" Written by Linus Torvalds and Dan Holmsand . -.sp .SH "DOCUMENTATION" Documentation by David Greaves, Junio C Hamano and the git\-list . -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + diff --git a/man1/git-send-pack.1 b/man1/git-send-pack.1 index aa94acf88..315bf4ec3 100644 --- a/man1/git-send-pack.1 +++ b/man1/git-send-pack.1 @@ -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\-SEND\-PACK" "1" "10/12/2006" "" "" +.TH "GIT\-SEND\-PACK" "1" "01/17/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -11,16 +11,14 @@ git\-send\-pack \- Push missing objects packed .SH "SYNOPSIS" \fIgit\-send\-pack\fR [\-\-all] [\-\-force] [\-\-exec=] [:] [\&...] -.sp .SH "DESCRIPTION" +Usually you would want to use \fBgit\-push\fR(1) which is a higher level wrapper of this command instead. + Invokes \fIgit\-receive\-pack\fR on a possibly remote repository, and updates it from the current repository, sending named refs. -.sp .SH "OPTIONS" .TP \-\-exec= -Path to the -\fIgit\-receive\-pack\fR -program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. +Path to the \fIgit\-receive\-pack\fR program on the remote end. Sometimes useful when pushing to a remote repository over ssh, and you do not have the program in a directory on the default $PATH. .TP \-\-all Instead of explicitly specifying which refs to update, update all refs that locally exist. @@ -29,9 +27,7 @@ Instead of explicitly specifying which refs to update, update all refs that loca Usually, the command refuses to update a remote ref that is not an ancestor of the local ref used to overwrite it. This flag disables the check. What this means is that the remote repository can lose commits; use it with care. .TP -A remote host to house the repository. When this part is specified, -\fIgit\-receive\-pack\fR -is invoked via ssh. +A remote host to house the repository. When this part is specified, \fIgit\-receive\-pack\fR is invoked via ssh. .TP The repository to update. @@ -40,15 +36,14 @@ The repository to update. The remote refs to update. .SH "SPECIFYING THE REFS" There are three ways to specify which refs to update on the remote end. -.sp + With \fI\-\-all\fR flag, all refs that exist locally are transferred to the remote side. You cannot specify any \fI\fR if you use this flag. -.sp + Without \fI\-\-all\fR and without any \fI\fR, the refs that exist both on the local side and on the remote side are updated. -.sp + When one or more \fI\fR are specified explicitly, it can be either a single pattern, or a pair of such pattern separated by a colon ":" (this means that a ref name cannot have a colon in it). A single pattern \fI\fR is just a shorthand for \fI:\fR. -.sp + Each pattern pair consists of the source side (before the colon) and the destination side (after the colon). The ref to be pushed is determined by finding a match that matches the source side, and where it is pushed is determined by using the destination side. -.sp .TP 3 \(bu It is an error if does not match exactly one of the local refs. @@ -67,17 +62,14 @@ it has to start with "refs/"; is used as the destination literally in this == and the ref that matched the must not exist in the set of remote refs; the ref matched locally is used as the name of the destination. .RE Without \fI\-\-force\fR, the ref is stored at the remote only if does not exist, or is a proper subset (i.e. an ancestor) of . This check, known as "fast forward check", is performed in order to avoid accidentally overwriting the remote ref and lose other peoples' commits from there. -.sp + With \fI\-\-force\fR, the fast forward check is disabled for all refs. -.sp + Optionally, a parameter can be prefixed with a plus \fI+\fR sign to disable the fast\-forward check only on that ref. -.sp .SH "AUTHOR" Written by Linus Torvalds -.sp .SH "DOCUMENTATION" Documentation by Junio C Hamano. -.sp .SH "GIT" Part of the \fBgit\fR(7) suite -.sp + -- 2.26.2