diff options
Diffstat (limited to 'man1/git-clone.1')
-rw-r--r-- | man1/git-clone.1 | 60 |
1 files changed, 37 insertions, 23 deletions
diff --git a/man1/git-clone.1 b/man1/git-clone.1 index 585390c4f..533f4cba4 100644 --- a/man1/git-clone.1 +++ b/man1/git-clone.1 @@ -2,12 +2,12 @@ .\" Title: git-clone .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 2024-03-18 +.\" Date: 2024-03-21 .\" Manual: Git Manual -.\" Source: Git 2.44.0.279.g3bd955d269 +.\" Source: Git 2.44.0.325.g11c821f2f2 .\" Language: English .\" -.TH "GIT\-CLONE" "1" "2024\-03\-18" "Git 2\&.44\&.0\&.279\&.g3bd955" "Git Manual" +.TH "GIT\-CLONE" "1" "2024\-03\-21" "Git 2\&.44\&.0\&.325\&.g11c821" "Git Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -116,9 +116,12 @@ to copy all objects from the source repository into a pack in the cloned reposit .PP \-\-reference[\-if\-able] <repository> .RS 4 -If the reference repository is on the local machine, automatically setup +If the reference +\fI<repository>\fR +is on the local machine, automatically setup \fB\&.git/objects/info/alternates\fR -to obtain objects from the reference repository\&. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs\&. When using the +to obtain objects from the reference +\fI<repository>\fR\&. Using an already existing repository as an alternate will require fewer objects to be copied from the repository being cloned, reducing network and local storage costs\&. When using the \fB\-\-reference\-if\-able\fR, a non existing directory is skipped with a warning instead of aborting the clone\&. .sp \fBNOTE\fR: see the NOTE for the @@ -167,7 +170,7 @@ No checkout of HEAD is performed after the clone is complete\&. \-\-[no\-]reject\-shallow .RS 4 Fail if the source repository is a shallow repository\&. The -\fIclone\&.rejectShallow\fR +\fBclone\&.rejectShallow\fR configuration variable can be used to specify the default\&. .RE .PP @@ -176,10 +179,10 @@ configuration variable can be used to specify the default\&. Make a \fIbare\fR Git repository\&. That is, instead of creating -\fB<directory>\fR +\fI<directory>\fR and placing the administrative files in \fB<directory>/\&.git\fR, make the -\fB<directory>\fR +\fI<directory>\fR itself the \fB$GIT_DIR\fR\&. This obviously implies the \fB\-\-no\-checkout\fR @@ -198,13 +201,13 @@ command can be used to grow the working directory as needed\&. .RS 4 Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter\&. When using \fB\-\-filter\fR, the supplied -\fB<filter\-spec>\fR +\fI<filter\-spec>\fR is used for the partial clone filter\&. For example, \fB\-\-filter=blob:none\fR will filter out all blobs (file contents) until needed by Git\&. Also, \fB\-\-filter=blob:limit=<size>\fR will filter out all blobs of size at least -\fB<size>\fR\&. For more details on filter specifications, see the +\fI<size>\fR\&. For more details on filter specifications, see the \fB\-\-filter\fR option in \fBgit-rev-list\fR(1)\&. @@ -236,7 +239,7 @@ in the target repository\&. Instead of using the remote name \fBorigin\fR to keep track of the upstream repository, use -\fB<name>\fR\&. Overrides +\fI<name>\fR\&. Overrides \fBclone\&.defaultRemoteName\fR from the config\&. .RE @@ -244,7 +247,7 @@ from the config\&. \-b <name>, \-\-branch <name> .RS 4 Instead of pointing the newly created HEAD to the branch pointed to by the cloned repository\(cqs HEAD, point to -\fB<name>\fR +\fI<name>\fR branch instead\&. In a non\-bare repository, this is the branch that will be checked out\&. \fB\-\-branch\fR can also take tags and detaches the HEAD at that commit in the resulting repository\&. @@ -263,7 +266,9 @@ Specify the directory from which templates will be used; (See the "TEMPLATE DIRE .PP \-c <key>=<value>, \-\-config <key>=<value> .RS 4 -Set a configuration variable in the newly\-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out\&. The key is in the same format as expected by +Set a configuration variable in the newly\-created repository; this takes effect immediately after the repository is initialized, but before the remote history is fetched or any files checked out\&. The +\fI<key>\fR +is in the same format as expected by \fBgit-config\fR(1) (e\&.g\&., \fBcore\&.eol=true\fR)\&. If multiple values are given for the same key, each value will be written to the config file\&. This makes it safe, for example, to add additional fetch refspecs to the origin remote\&. @@ -306,7 +311,9 @@ Clone only the history leading to the tip of a single branch, either specified b \fB\-\-branch\fR option or the primary branch remote\(cqs \fBHEAD\fR -points at\&. Further fetches into the resulting repository will only update the remote\-tracking branch for the branch this option was used for the initial cloning\&. If the HEAD at the remote did not point at any branch when +points at\&. Further fetches into the resulting repository will only update the remote\-tracking branch for the branch this option was used for the initial cloning\&. If the +\fBHEAD\fR +at the remote did not point at any branch when \fB\-\-single\-branch\fR clone was made, no remote\-tracking branch is created\&. .RE @@ -329,7 +336,10 @@ to clone and maintain a branch with no references other than a single cloned bra .PP \-\-recurse\-submodules[=<pathspec>] .RS 4 -After the clone is created, initialize and clone submodules within based on the provided pathspec\&. If no pathspec is provided, all submodules are initialized and cloned\&. This option can be given multiple times for pathspecs consisting of multiple entries\&. The resulting clone has +After the clone is created, initialize and clone submodules within based on the provided +\fI<pathspec>\fR\&. If no +\fI=<pathspec>\fR +is provided, all submodules are initialized and cloned\&. This option can be given multiple times for pathspecs consisting of multiple entries\&. The resulting clone has \fBsubmodule\&.active\fR set to the provided pathspec, or "\&." (meaning all submodules) if no pathspec is provided\&. .sp @@ -398,14 +408,18 @@ option\&. .PP <repository> .RS 4 -The (possibly remote) repository to clone from\&. See the +The (possibly remote) +\fI<repository>\fR +to clone from\&. See the GIT URLS section below for more information on specifying repositories\&. .RE .PP <directory> .RS 4 -The name of a new directory to clone into\&. The "humanish" part of the source repository is used if no directory is explicitly given (\fBrepo\fR +The name of a new directory to clone into\&. The "humanish" part of the source repository is used if no +\fI<directory>\fR +is explicitly given (\fBrepo\fR for \fB/path/to/repo\&.git\fR and @@ -417,7 +431,7 @@ for \-\-bundle\-uri=<uri> .RS 4 Before fetching from the remote, fetch a bundle from the given -\fB<uri>\fR +\fI<uri>\fR and unbundle the data into the local repository\&. The refs in the bundle will be stored under the hidden \fBrefs/bundle/*\fR namespace\&. This option is incompatible with @@ -553,11 +567,11 @@ For local repositories, also supported by Git natively, the following syntaxes m file:///path/to/repo\&.git/ .RE .sp -These two syntaxes are mostly equivalent, except the former implies \-\-local option\&. +These two syntaxes are mostly equivalent, except the former implies \fB\-\-local\fR option\&. .sp -\fIgit clone\fR, \fIgit fetch\fR and \fIgit pull\fR, but not \fIgit push\fR, will also accept a suitable bundle file\&. See \fBgit-bundle\fR(1)\&. +\fBgit clone\fR, \fBgit fetch\fR and \fBgit pull\fR, but not \fBgit push\fR, will also accept a suitable bundle file\&. See \fBgit-bundle\fR(1)\&. .sp -When Git doesn\(cqt know how to handle a certain transport protocol, it attempts to use the \fIremote\-<transport>\fR remote helper, if one exists\&. To explicitly request a remote helper, the following syntax may be used: +When Git doesn\(cqt know how to handle a certain transport protocol, it attempts to use the \fBremote\-<transport>\fR remote helper, if one exists\&. To explicitly request a remote helper, the following syntax may be used: .sp .RS 4 .ie n \{\ @@ -567,10 +581,10 @@ When Git doesn\(cqt know how to handle a certain transport protocol, it attempts .sp -1 .IP \(bu 2.3 .\} -<transport>::<address> +\fI<transport>\fR::_<address>_ .RE .sp -where <address> may be a path, a server and path, or an arbitrary URL\-like string recognized by the specific remote helper being invoked\&. See \fBgitremote-helpers\fR(7) for details\&. +where \fI<address>\fR may be a path, a server and path, or an arbitrary URL\-like string recognized by the specific remote helper being invoked\&. See \fBgitremote-helpers\fR(7) for details\&. .sp If there are a large number of similarly\-named remote repositories and you want to use a different format for them (such that the URLs you use will be rewritten into URLs that work), you can create a configuration section of the form: .sp |