From: Junio C Hamano Date: Thu, 21 Sep 2006 08:13:37 +0000 (+0000) Subject: Autogenerated man pages for v1.4.2.1-g199a9 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=56395428ed265c5f42ff3454c7ec93fb20d45bac;p=git.git Autogenerated man pages for v1.4.2.1-g199a9 --- diff --git a/man1/git-init-db.1 b/man1/git-init-db.1 index 742da1f34..a4e72c4db 100755 --- a/man1/git-init-db.1 +++ b/man1/git-init-db.1 @@ -1,101 +1,88 @@ -.\"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-INIT-DB" 1 "" "" "" -.SH NAME -git-init-db \- Creates an empty git repository +.\" ** 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\-INIT\-DB" "1" "09/21/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-init\-db \- Creates an empty git repository .SH "SYNOPSIS" - - \fIgit\-init\-db\fR [\-\-template=] [\-\-shared[=]] - +.sp .SH "OPTIONS" - .TP \-\-template= -Provide the directory from which templates will be used\&. The default template directory is /usr/share/git\-core/templates\&. - -When specified, is used as the source of the template files rather than the default\&. The template files include some directory structure, some suggested "exclude patterns", and copies of non\-executing "hook" files\&. The suggested patterns and hook files are all modifiable and extensible\&. - +Provide the directory from which templates will be used. The default template directory is +/usr/share/git\-core/templates. +.sp +When specified, + +is used as the source of the template files rather than the default. The template files include some directory structure, some suggested "exclude patterns", and copies of non\-executing "hook" files. The suggested patterns and hook files are all modifiable and extensible. .TP \-\-shared[={false|true|umask|group|all|world|everybody}] -Specify that the git repository is to be shared amongst several users\&. This allows users belonging to the same group to push into that repository\&. When specified, the config variable "core\&.sharedRepository" is set so that files and directories under $GIT_DIR are created with the requested permissions\&. When not specified, git will use permissions reported by umask(2)\&. - -The option can have the following values, defaulting to \fIgroup\fR if no value is given: - +Specify that the git repository is to be shared amongst several users. This allows users belonging to the same group to push into that repository. When specified, the config variable "core.sharedRepository" is set so that files and directories under +$GIT_DIR +are created with the requested permissions. When not specified, git will use permissions reported by umask(2). +.sp +The option can have the following values, defaulting to +\fIgroup\fR +if no value is given: .RS .TP 3 \(bu - \fIumask\fR (or \fIfalse\fR): Use permissions reported by umask(2)\&. The default, when \-\-shared is not specified\&. +\fIumask\fR +(or +\fIfalse\fR): Use permissions reported by umask(2). The default, when +\-\-shared +is not specified. .TP \(bu - \fIgroup\fR (or \fItrue\fR): Make the repository group\-writable, (and g+sx, since the git group may be not the primary group of all users)\&. +\fIgroup\fR +(or +\fItrue\fR): Make the repository group\-writable, (and g+sx, since the git group may be not the primary group of all users). .TP \(bu - \fIall\fR (or \fIworld\fR or \fIeverybody\fR): Same as \fIgroup\fR, but make the repository readable by all users\&. -.LP +\fIall\fR +(or +\fIworld\fR +or +\fIeverybody\fR): Same as +\fIgroup\fR, but make the repository readable by all users. +.sp +By default, the configuration flag receive.denyNonFastforward is enabled in shared repositories, so that you cannot force a non fast\-forwarding push into it. .RE -.IP - .SH "DESCRIPTION" - - -This command creates an empty git repository \- basically a \&.git directory with subdirectories for objects, refs/heads, refs/tags, and template files\&. An initial HEAD file that references the HEAD of the master branch is also created\&. - - -If the $GIT_DIR environment variable is set then it specifies a path to use instead of \&./\&.git for the base of the repository\&. - - -If the object storage directory is specified via the $GIT_OBJECT_DIRECTORY environment variable then the sha1 directories are created underneath \- otherwise the default $GIT_DIR/objects directory is used\&. - - -Running git\-init\-db in an existing repository is safe\&. It will not overwrite things that are already there\&. The primary reason for rerunning git\-init\-db is to pick up newly added templates\&. - +This command creates an empty git repository \- basically a .git directory with subdirectories for objects, refs/heads, refs/tags, and template files. An initial HEAD file that references the HEAD of the master branch is also created. +.sp +If the $GIT_DIR environment variable is set then it specifies a path to use instead of ./.git for the base of the repository. +.sp +If the object storage directory is specified via the $GIT_OBJECT_DIRECTORY environment variable then the sha1 directories are created underneath \- otherwise the default $GIT_DIR/objects directory is used. +.sp +Running git\-init\-db in an existing repository is safe. It will not overwrite things that are already there. The primary reason for rerunning git\-init\-db is to pick up newly added templates. +.sp .SH "EXAMPLES" - .TP Start a new git repository for an existing code base - +.sp .nf $ cd /path/to/my/codebase $ git\-init\-db \fB(1)\fR -$ git\-add \&. \fB(2)\fR +$ git\-add . \fB(2)\fR .fi .sp -\fB1. \fRprepare /path/to/my/codebase/\&.git directory +\fB1. \fRprepare /path/to/my/codebase/.git directory .br \fB2. \fRadd all existing file to the index .br - - .SH "AUTHOR" - - -Written by Linus Torvalds - +Written by Linus Torvalds +.sp .SH "DOCUMENTATION" - - -Documentation by David Greaves, Junio C Hamano and the git\-list \&. - +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-receive-pack.1 b/man1/git-receive-pack.1 index efa59b530..896a4b0b6 100755 --- a/man1/git-receive-pack.1 +++ b/man1/git-receive-pack.1 @@ -1,60 +1,40 @@ -.\"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-RECEIVE-PACK" 1 "" "" "" -.SH NAME -git-receive-pack \- Receive what is pushed into it +.\" ** 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\-RECEIVE\-PACK" "1" "09/21/2006" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +git\-receive\-pack \- Receive what is pushed into it .SH "SYNOPSIS" - - \fIgit\-receive\-pack\fR - +.sp .SH "DESCRIPTION" - - -Invoked by \fIgit\-send\-pack\fR and updates the repository with the information fed from the remote end\&. - - -This command is usually not invoked directly by the end user\&. The UI for the protocol is on the \fIgit\-send\-pack\fR side, and the program pair is meant to be used to push updates to remote repository\&. For pull operations, see \fIgit\-fetch\-pack\fR\&. - - -The command allows for creation and fast forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the local end receive\-pack runs, but to the user who is sitting at the send\-pack end, it is updating the remote\&. Confused?) - - +Invoked by \fIgit\-send\-pack\fR and updates the repository with the information fed from the remote end. +.sp +This command is usually not invoked directly by the end user. The UI for the protocol is on the \fIgit\-send\-pack\fR side, and the program pair is meant to be used to push updates to remote repository. For pull operations, see \fIgit\-fetch\-pack\fR. +.sp +The command allows for creation and fast forwarding of sha1 refs (heads/tags) on the remote end (strictly speaking, it is the local end receive\-pack runs, but to the user who is sitting at the send\-pack end, it is updating the remote. Confused?) +.sp Before each ref is updated, if $GIT_DIR/hooks/update file exists and executable, it is called with three parameters: - +.sp +.sp .nf $GIT_DIR/hooks/update refname sha1\-old sha1\-new .fi - - -The refname parameter is relative to $GIT_DIR; e\&.g\&. for the master head this is "refs/heads/master"\&. Two sha1 are the object names for the refname before and after the update\&. Note that the hook is called before the refname is updated, so either should match what is recorded in refname\&. - - -The hook should exit with non\-zero status if it wants to disallow updating the named ref\&. Otherwise it should exit with zero\&. - - -Using this hook, it is easy to generate mails on updates to the local repository\&. This example script sends a mail with the commits pushed to the repository: - +The refname parameter is relative to $GIT_DIR; e.g. for the master head this is "refs/heads/master". Two sha1 are the object names for the refname before and after the update. Note that the hook is called before the refname is updated, so either should match what is recorded in refname. +.sp +The hook should exit with non\-zero status if it wants to disallow updating the named ref. Otherwise it should exit with zero. +.sp +Using this hook, it is easy to generate mails on updates to the local repository. This example script sends a mail with the commits pushed to the repository: +.sp +.sp .nf #!/bin/sh -# mail out commit update information\&. +# mail out commit update information. if expr "$2" : '0*$' >/dev/null then echo "Created a new ref, with the following commits:" @@ -66,41 +46,30 @@ fi | mail \-s "Changes to ref $1" commit\-list@mydomain exit 0 .fi - - -Another hook $GIT_DIR/hooks/post\-update, if exists and executable, is called with the list of refs that have been updated\&. This can be used to implement repository wide cleanup task if needed\&. The exit code from this hook invocation is ignored; the only thing left for git\-receive\-pack to do at that point is to exit itself anyway\&. This hook can be used, for example, to run "git\-update\-server\-info" if the repository is packed and is served via a dumb transport\&. - +Another hook $GIT_DIR/hooks/post\-update, if exists and executable, is called with the list of refs that have been updated. This can be used to implement repository wide cleanup task if needed. The exit code from this hook invocation is ignored; the only thing left for git\-receive\-pack to do at that point is to exit itself anyway. This hook can be used, for example, to run "git\-update\-server\-info" if the repository is packed and is served via a dumb transport. +.sp +.sp .nf #!/bin/sh exec git\-update\-server\-info .fi - - -There are other real\-world examples of using update and post\-update hooks found in the Documentation/howto directory\&. - +There are other real\-world examples of using update and post\-update hooks found in the Documentation/howto directory. +.sp +git\-receive\-pack honours the receive.denyNonFastforwards flag, which tells it if updates to a ref should be denied if they are not fast\-forwards. +.sp .SH "OPTIONS" - .TP -The repository to sync into\&. - +The repository to sync into. .SH "SEE ALSO" - - \fBgit\-send\-pack\fR(1) - +.sp .SH "AUTHOR" - - -Written by Linus Torvalds - +Written by Linus Torvalds +.sp .SH "DOCUMENTATION" - - -Documentation by Junio C Hamano\&. - +Documentation by Junio C Hamano. +.sp .SH "GIT" - - Part of the \fBgit\fR(7) suite - +.sp diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index 4f83c51d0..9d2778532 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.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\-REPO\-CONFIG" "1" "09/18/2006" "" "" +.TH "GIT\-REPO\-CONFIG" "1" "09/21/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -451,6 +451,9 @@ The configuration variables in the \fIimap\fR section are described in \fBgit\-imap\-send\fR(1). +.TP +receive.denyNonFastforwads +If set to true, git\-receive\-pack will deny a ref update which is not a fast forward. Use this to prevent such an update via a push, even if that push is forced. This configuration variable is set when initializing a shared repository. .SH "AUTHOR" Written by Johannes Schindelin .sp