doc: apply synopsis simplification on git-clone and git-init
With the new synopsis formatting backend, no special asciidoc markup is needed. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>maint
parent
029eff9e34
commit
22293895c0
|
@ -8,16 +8,16 @@ git-clone - Clone a repository into a new directory
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[synopsis]
|
||||||
`git clone` [++--template=++__<template-directory>__]
|
git clone [--template=<template-directory>]
|
||||||
[`-l`] [`-s`] [`--no-hardlinks`] [`-q`] [`-n`] [`--bare`] [`--mirror`]
|
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
|
||||||
[`-o` _<name>_] [`-b` _<name>_] [`-u` _<upload-pack>_] [`--reference` _<repository>_]
|
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
|
||||||
[`--dissociate`] [`--separate-git-dir` _<git-dir>_]
|
[--dissociate] [--separate-git-dir <git-dir>]
|
||||||
[`--depth` _<depth>_] [`--`[`no-`]{empty}`single-branch`] [`--no-tags`]
|
[--depth <depth>] [--[no-]single-branch] [--no-tags]
|
||||||
[++--recurse-submodules++[++=++__<pathspec>__]] [++--++[++no-++]{empty}++shallow-submodules++]
|
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
|
||||||
[`--`[`no-`]{empty}`remote-submodules`] [`--jobs` _<n>_] [`--sparse`] [`--`[`no-`]{empty}`reject-shallow`]
|
[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
|
||||||
[++--filter=++__<filter-spec>__] [`--also-filter-submodules`]] [`--`] _<repository>_
|
[--filter=<filter-spec>] [--also-filter-submodules]] [--] <repository>
|
||||||
[_<directory>_]
|
[<directory>]
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
-----------
|
-----------
|
||||||
|
@ -52,7 +52,7 @@ OPTIONS
|
||||||
to save space when possible.
|
to save space when possible.
|
||||||
+
|
+
|
||||||
If the repository is specified as a local path (e.g., `/path/to/repo`),
|
If the repository is specified as a local path (e.g., `/path/to/repo`),
|
||||||
this is the default, and --local is essentially a no-op. If the
|
this is the default, and `--local` is essentially a no-op. If the
|
||||||
repository is specified as a URL, then this flag is ignored (and we
|
repository is specified as a URL, then this flag is ignored (and we
|
||||||
never use the local optimizations). Specifying `--no-local` will
|
never use the local optimizations). Specifying `--no-local` will
|
||||||
override the default when `/path/to/repo` is given, using the regular
|
override the default when `/path/to/repo` is given, using the regular
|
||||||
|
@ -64,8 +64,8 @@ prevent the unintentional copying of files by dereferencing the symbolic
|
||||||
links.
|
links.
|
||||||
+
|
+
|
||||||
*NOTE*: this operation can race with concurrent modification to the
|
*NOTE*: this operation can race with concurrent modification to the
|
||||||
source repository, similar to running `cp -r src dst` while modifying
|
source repository, similar to running `cp -r <src> <dst>` while modifying
|
||||||
`src`.
|
_<src>_.
|
||||||
|
|
||||||
`--no-hardlinks`::
|
`--no-hardlinks`::
|
||||||
Force the cloning process from a repository on a local
|
Force the cloning process from a repository on a local
|
||||||
|
@ -101,7 +101,7 @@ If you want to break the dependency of a repository cloned with `--shared` on
|
||||||
its source repository, you can simply run `git repack -a` to copy all
|
its source repository, you can simply run `git repack -a` to copy all
|
||||||
objects from the source repository into a pack in the cloned repository.
|
objects from the source repository into a pack in the cloned repository.
|
||||||
|
|
||||||
`--reference`[`-if-able`] _<repository>_::
|
`--reference[-if-able] <repository>`::
|
||||||
If the reference _<repository>_ is on the local machine,
|
If the reference _<repository>_ is on the local machine,
|
||||||
automatically setup `.git/objects/info/alternates` to
|
automatically setup `.git/objects/info/alternates` to
|
||||||
obtain objects from the reference _<repository>_. Using
|
obtain objects from the reference _<repository>_. Using
|
||||||
|
@ -142,17 +142,17 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
is specified. This flag forces progress status even if the
|
is specified. This flag forces progress status even if the
|
||||||
standard error stream is not directed to a terminal.
|
standard error stream is not directed to a terminal.
|
||||||
|
|
||||||
++--server-option=++__<option>__::
|
`--server-option=<option>`::
|
||||||
Transmit the given string to the server when communicating using
|
Transmit the given string to the server when communicating using
|
||||||
protocol version 2. The given string must not contain a NUL or LF
|
protocol version 2. The given string must not contain a NUL or LF
|
||||||
character. The server's handling of server options, including
|
character. The server's handling of server options, including
|
||||||
unknown ones, is server-specific.
|
unknown ones, is server-specific.
|
||||||
When multiple ++--server-option=++__<option>__ are given, they are all
|
When multiple `--server-option=<option>` are given, they are all
|
||||||
sent to the other side in the order listed on the command line.
|
sent to the other side in the order listed on the command line.
|
||||||
|
|
||||||
`-n`::
|
`-n`::
|
||||||
`--no-checkout`::
|
`--no-checkout`::
|
||||||
No checkout of HEAD is performed after the clone is complete.
|
No checkout of `HEAD` is performed after the clone is complete.
|
||||||
|
|
||||||
`--`[`no-`]`reject-shallow`::
|
`--`[`no-`]`reject-shallow`::
|
||||||
Fail if the source repository is a shallow repository.
|
Fail if the source repository is a shallow repository.
|
||||||
|
@ -162,7 +162,7 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
`--bare`::
|
`--bare`::
|
||||||
Make a 'bare' Git repository. That is, instead of
|
Make a 'bare' Git repository. That is, instead of
|
||||||
creating _<directory>_ and placing the administrative
|
creating _<directory>_ and placing the administrative
|
||||||
files in _<directory>_`/.git`, make the _<directory>_
|
files in `<directory>/.git`, make the _<directory>_
|
||||||
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
|
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
|
||||||
because there is nowhere to check out the working tree.
|
because there is nowhere to check out the working tree.
|
||||||
Also the branch heads at the remote are copied directly
|
Also the branch heads at the remote are copied directly
|
||||||
|
@ -177,13 +177,13 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
linkgit:git-sparse-checkout[1] command can be used to grow the
|
linkgit:git-sparse-checkout[1] command can be used to grow the
|
||||||
working directory as needed.
|
working directory as needed.
|
||||||
|
|
||||||
++--filter=++__<filter-spec>__::
|
`--filter=<filter-spec>`::
|
||||||
Use the partial clone feature and request that the server sends
|
Use the partial clone feature and request that the server sends
|
||||||
a subset of reachable objects according to a given object filter.
|
a subset of reachable objects according to a given object filter.
|
||||||
When using `--filter`, the supplied _<filter-spec>_ is used for
|
When using `--filter`, the supplied _<filter-spec>_ is used for
|
||||||
the partial clone filter. For example, `--filter=blob:none` will
|
the partial clone filter. For example, `--filter=blob:none` will
|
||||||
filter out all blobs (file contents) until needed by Git. Also,
|
filter out all blobs (file contents) until needed by Git. Also,
|
||||||
++--filter=blob:limit=++__<size>__ will filter out all blobs of size
|
`--filter=blob:limit=<size>` will filter out all blobs of size
|
||||||
at least _<size>_. For more details on filter specifications, see
|
at least _<size>_. For more details on filter specifications, see
|
||||||
the `--filter` option in linkgit:git-rev-list[1].
|
the `--filter` option in linkgit:git-rev-list[1].
|
||||||
|
|
||||||
|
@ -208,11 +208,11 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
|
|
||||||
`-b` _<name>_::
|
`-b` _<name>_::
|
||||||
`--branch` _<name>_::
|
`--branch` _<name>_::
|
||||||
Instead of pointing the newly created HEAD to the branch pointed
|
Instead of pointing the newly created `HEAD` to the branch pointed
|
||||||
to by the cloned repository's HEAD, point to _<name>_ branch
|
to by the cloned repository's `HEAD`, point to _<name>_ branch
|
||||||
instead. In a non-bare repository, this is the branch that will
|
instead. In a non-bare repository, this is the branch that will
|
||||||
be checked out.
|
be checked out.
|
||||||
`--branch` can also take tags and detaches the HEAD at that commit
|
`--branch` can also take tags and detaches the `HEAD` at that commit
|
||||||
in the resulting repository.
|
in the resulting repository.
|
||||||
|
|
||||||
`-u` _<upload-pack>_::
|
`-u` _<upload-pack>_::
|
||||||
|
@ -221,12 +221,12 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
via ssh, this specifies a non-default path for the command
|
via ssh, this specifies a non-default path for the command
|
||||||
run on the other end.
|
run on the other end.
|
||||||
|
|
||||||
++--template=++__<template-directory>__::
|
`--template=<template-directory>`::
|
||||||
Specify the directory from which templates will be used;
|
Specify the directory from which templates will be used;
|
||||||
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
||||||
|
|
||||||
`-c` __<key>__++=++__<value>__::
|
`-c` `<key>=<value>`::
|
||||||
`--config` __<key>__++=++__<value>__::
|
`--config` `<key>=<value>`::
|
||||||
Set a configuration variable in the newly-created repository;
|
Set a configuration variable in the newly-created repository;
|
||||||
this takes effect immediately after the repository is
|
this takes effect immediately after the repository is
|
||||||
initialized, but before the remote history is fetched or any
|
initialized, but before the remote history is fetched or any
|
||||||
|
@ -239,25 +239,25 @@ objects from the source repository into a pack in the cloned repository.
|
||||||
Due to limitations of the current implementation, some configuration
|
Due to limitations of the current implementation, some configuration
|
||||||
variables do not take effect until after the initial fetch and checkout.
|
variables do not take effect until after the initial fetch and checkout.
|
||||||
Configuration variables known to not take effect are:
|
Configuration variables known to not take effect are:
|
||||||
++remote.++__<name>__++.mirror++ and ++remote.++__<name>__++.tagOpt++. Use the
|
`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
|
||||||
corresponding `--mirror` and `--no-tags` options instead.
|
corresponding `--mirror` and `--no-tags` options instead.
|
||||||
|
|
||||||
`--depth` _<depth>_::
|
`--depth <depth>`::
|
||||||
Create a 'shallow' clone with a history truncated to the
|
Create a 'shallow' clone with a history truncated to the
|
||||||
specified number of commits. Implies `--single-branch` unless
|
specified number of commits. Implies `--single-branch` unless
|
||||||
`--no-single-branch` is given to fetch the histories near the
|
`--no-single-branch` is given to fetch the histories near the
|
||||||
tips of all branches. If you want to clone submodules shallowly,
|
tips of all branches. If you want to clone submodules shallowly,
|
||||||
also pass `--shallow-submodules`.
|
also pass `--shallow-submodules`.
|
||||||
|
|
||||||
++--shallow-since=++__<date>__::
|
`--shallow-since=<date>`::
|
||||||
Create a shallow clone with a history after the specified time.
|
Create a shallow clone with a history after the specified time.
|
||||||
|
|
||||||
++--shallow-exclude=++__<revision>__::
|
`--shallow-exclude=<revision>`::
|
||||||
Create a shallow clone with a history, excluding commits
|
Create a shallow clone with a history, excluding commits
|
||||||
reachable from a specified remote branch or tag. This option
|
reachable from a specified remote branch or tag. This option
|
||||||
can be specified multiple times.
|
can be specified multiple times.
|
||||||
|
|
||||||
`--`[`no-`]`single-branch`::
|
`--[no-]single-branch`::
|
||||||
Clone only the history leading to the tip of a single branch,
|
Clone only the history leading to the tip of a single branch,
|
||||||
either specified by the `--branch` option or the primary
|
either specified by the `--branch` option or the primary
|
||||||
branch remote's `HEAD` points at.
|
branch remote's `HEAD` points at.
|
||||||
|
@ -279,13 +279,13 @@ maintain a branch with no references other than a single cloned
|
||||||
branch. This is useful e.g. to maintain minimal clones of the default
|
branch. This is useful e.g. to maintain minimal clones of the default
|
||||||
branch of some repository for search indexing.
|
branch of some repository for search indexing.
|
||||||
|
|
||||||
`--recurse-submodules`[`=`{empty}__<pathspec>__]::
|
`--recurse-submodules[=<pathspec>]`::
|
||||||
After the clone is created, initialize and clone submodules
|
After the clone is created, initialize and clone submodules
|
||||||
within based on the provided _<pathspec>_. If no _=<pathspec>_ is
|
within based on the provided _<pathspec>_. If no `=<pathspec>` is
|
||||||
provided, all submodules are initialized and cloned.
|
provided, all submodules are initialized and cloned.
|
||||||
This option can be given multiple times for pathspecs consisting
|
This option can be given multiple times for pathspecs consisting
|
||||||
of multiple entries. The resulting clone has `submodule.active` set to
|
of multiple entries. The resulting clone has `submodule.active` set to
|
||||||
the provided pathspec, or "." (meaning all submodules) if no
|
the provided pathspec, or "`.`" (meaning all submodules) if no
|
||||||
pathspec is provided.
|
pathspec is provided.
|
||||||
+
|
+
|
||||||
Submodules are initialized and cloned using their default settings. This is
|
Submodules are initialized and cloned using their default settings. This is
|
||||||
|
@ -295,23 +295,23 @@ the clone is finished. This option is ignored if the cloned repository does
|
||||||
not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
|
not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
|
||||||
or `--mirror` is given)
|
or `--mirror` is given)
|
||||||
|
|
||||||
`--`[`no-`]`shallow-submodules`::
|
`--[no-]shallow-submodules`::
|
||||||
All submodules which are cloned will be shallow with a depth of 1.
|
All submodules which are cloned will be shallow with a depth of 1.
|
||||||
|
|
||||||
`--`[`no-`]`remote-submodules`::
|
`--[no-]remote-submodules`::
|
||||||
All submodules which are cloned will use the status of the submodule's
|
All submodules which are cloned will use the status of the submodule's
|
||||||
remote-tracking branch to update the submodule, rather than the
|
remote-tracking branch to update the submodule, rather than the
|
||||||
superproject's recorded SHA-1. Equivalent to passing `--remote` to
|
superproject's recorded SHA-1. Equivalent to passing `--remote` to
|
||||||
`git submodule update`.
|
`git submodule update`.
|
||||||
|
|
||||||
`--separate-git-dir=`{empty}__<git-dir>__::
|
`--separate-git-dir=<git-dir>`::
|
||||||
Instead of placing the cloned repository where it is supposed
|
Instead of placing the cloned repository where it is supposed
|
||||||
to be, place the cloned repository at the specified directory,
|
to be, place the cloned repository at the specified directory,
|
||||||
then make a filesystem-agnostic Git symbolic link to there.
|
then make a filesystem-agnostic Git symbolic link to there.
|
||||||
The result is Git repository can be separated from working
|
The result is Git repository can be separated from working
|
||||||
tree.
|
tree.
|
||||||
|
|
||||||
`--ref-format=`{empty}__<ref-format>__::
|
`--ref-format=<ref-format>`::
|
||||||
|
|
||||||
Specify the given ref storage format for the repository. The valid values are:
|
Specify the given ref storage format for the repository. The valid values are:
|
||||||
+
|
+
|
||||||
|
@ -334,7 +334,7 @@ _<directory>_::
|
||||||
for `host.xz:foo/.git`). Cloning into an existing directory
|
for `host.xz:foo/.git`). Cloning into an existing directory
|
||||||
is only allowed if the directory is empty.
|
is only allowed if the directory is empty.
|
||||||
|
|
||||||
`--bundle-uri=`{empty}__<uri>__::
|
`--bundle-uri=<uri>`::
|
||||||
Before fetching from the remote, fetch a bundle from the given
|
Before fetching from the remote, fetch a bundle from the given
|
||||||
_<uri>_ and unbundle the data into the local repository. The refs
|
_<uri>_ and unbundle the data into the local repository. The refs
|
||||||
in the bundle will be stored under the hidden `refs/bundle/*`
|
in the bundle will be stored under the hidden `refs/bundle/*`
|
||||||
|
|
|
@ -8,12 +8,12 @@ git-init - Create an empty Git repository or reinitialize an existing one
|
||||||
|
|
||||||
SYNOPSIS
|
SYNOPSIS
|
||||||
--------
|
--------
|
||||||
[verse]
|
[synopsis]
|
||||||
`git init` [`-q` | `--quiet`] [`--bare`] [++--template=++__<template-directory>__]
|
git init [-q | --quiet] [--bare] [--template=<template-directory>]
|
||||||
[`--separate-git-dir` _<git-dir>_] [++--object-format=++__<format>__]
|
[--separate-git-dir <git-dir>] [--object-format=<format>]
|
||||||
[++--ref-format=++__<format>__]
|
[--ref-format=<format>]
|
||||||
[`-b` _<branch-name>_ | ++--initial-branch=++__<branch-name>__]
|
[-b <branch-name> | --initial-branch=<branch-name>]
|
||||||
[++--shared++[++=++__<permissions>__]] [_<directory>_]
|
[--shared[=<permissions>]] [<directory>]
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
DESCRIPTION
|
||||||
|
@ -25,11 +25,11 @@ directory with subdirectories for `objects`, `refs/heads`,
|
||||||
commits will be created (see the `--initial-branch` option below
|
commits will be created (see the `--initial-branch` option below
|
||||||
for its name).
|
for its name).
|
||||||
|
|
||||||
If the `$GIT_DIR` environment variable is set then it specifies a path
|
If the `GIT_DIR` environment variable is set then it specifies a path
|
||||||
to use instead of `./.git` for the base of the repository.
|
to use instead of `./.git` for the base of the repository.
|
||||||
|
|
||||||
If the object storage directory is specified via the
|
If the object storage directory is specified via the
|
||||||
`$GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories
|
`GIT_OBJECT_DIRECTORY` environment variable then the sha1 directories
|
||||||
are created underneath; otherwise, the default `$GIT_DIR/objects`
|
are created underneath; otherwise, the default `$GIT_DIR/objects`
|
||||||
directory is used.
|
directory is used.
|
||||||
|
|
||||||
|
@ -51,26 +51,22 @@ Only print error and warning messages; all other output will be suppressed.
|
||||||
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
|
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
|
||||||
current working directory.
|
current working directory.
|
||||||
|
|
||||||
++--object-format=++__<format>__::
|
`--object-format=<format>`::
|
||||||
|
|
||||||
Specify the given object _<format>_ (hash algorithm) for the repository. The valid
|
Specify the given object _<format>_ (hash algorithm) for the repository. The valid
|
||||||
values are `sha1` and (if enabled) `sha256`. `sha1` is the default.
|
values are `sha1` and (if enabled) `sha256`. `sha1` is the default.
|
||||||
+
|
+
|
||||||
include::object-format-disclaimer.txt[]
|
include::object-format-disclaimer.txt[]
|
||||||
|
|
||||||
++--ref-format=++__<format>__::
|
`--ref-format=<format>`::
|
||||||
|
|
||||||
Specify the given ref storage _<format>_ for the repository. The valid values are:
|
Specify the given ref storage _<format>_ for the repository. The valid values are:
|
||||||
+
|
+
|
||||||
include::ref-storage-format.txt[]
|
include::ref-storage-format.txt[]
|
||||||
|
|
||||||
++--template=++__<template-directory>__::
|
`--template=<template-directory>`::
|
||||||
|
|
||||||
Specify the directory from which templates will be used. (See the "TEMPLATE
|
Specify the directory from which templates will be used. (See the "TEMPLATE
|
||||||
DIRECTORY" section below.)
|
DIRECTORY" section below.)
|
||||||
|
|
||||||
++--separate-git-dir=++__<git-dir>__::
|
`--separate-git-dir=<git-dir>`::
|
||||||
|
|
||||||
Instead of initializing the repository as a directory to either `$GIT_DIR` or
|
Instead of initializing the repository as a directory to either `$GIT_DIR` or
|
||||||
`./.git/`, create a text file there containing the path to the actual
|
`./.git/`, create a text file there containing the path to the actual
|
||||||
repository. This file acts as a filesystem-agnostic Git symbolic link to the
|
repository. This file acts as a filesystem-agnostic Git symbolic link to the
|
||||||
|
@ -78,15 +74,14 @@ repository.
|
||||||
+
|
+
|
||||||
If this is a reinitialization, the repository will be moved to the specified path.
|
If this is a reinitialization, the repository will be moved to the specified path.
|
||||||
|
|
||||||
`-b` _<branch-name>_::
|
`-b <branch-name>`::
|
||||||
++--initial-branch=++__<branch-name>__::
|
`--initial-branch=<branch-name>`::
|
||||||
|
|
||||||
Use _<branch-name>_ for the initial branch in the newly created
|
Use _<branch-name>_ for the initial branch in the newly created
|
||||||
repository. If not specified, fall back to the default name (currently
|
repository. If not specified, fall back to the default name (currently
|
||||||
`master`, but this is subject to change in the future; the name can be
|
`master`, but this is subject to change in the future; the name can be
|
||||||
customized via the `init.defaultBranch` configuration variable).
|
customized via the `init.defaultBranch` configuration variable).
|
||||||
|
|
||||||
++--shared++[++=++(`false`|`true`|`umask`|`group`|`all`|`world`|`everybody`|_<perm>_)]::
|
`--shared[=(false|true|umask|group|all|world|everybody|<perm>)]`::
|
||||||
|
|
||||||
Specify that the Git repository is to be shared amongst several users. This
|
Specify that the Git repository is to be shared amongst several users. This
|
||||||
allows users belonging to the same group to push into that
|
allows users belonging to the same group to push into that
|
||||||
|
|
|
@ -10,19 +10,19 @@ Git supports ssh, git, http, and https protocols (in addition, ftp
|
||||||
and ftps can be used for fetching, but this is inefficient and
|
and ftps can be used for fetching, but this is inefficient and
|
||||||
deprecated; do not use them).
|
deprecated; do not use them).
|
||||||
|
|
||||||
The native transport (i.e. git:// URL) does no authentication and
|
The native transport (i.e. `git://` URL) does no authentication and
|
||||||
should be used with caution on unsecured networks.
|
should be used with caution on unsecured networks.
|
||||||
|
|
||||||
The following syntaxes may be used with them:
|
The following syntaxes may be used with them:
|
||||||
|
|
||||||
- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__
|
- `ssh://[<user>@]<host>[:<port>]/<path-to-git-repo>`
|
||||||
- ++git://++__<host>__{startsb}:__<port>__{endsb}++/++__<path-to-git-repo>__
|
- `git://<host>[:<port>]/<path-to-git-repo>`
|
||||||
- ++http++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__
|
- `http[s]://<host>[:<port>]/<path-to-git-repo>`
|
||||||
- ++ftp++{startsb}++s++{endsb}++://++__<host>__{startsb}++:++__<port>__{endsb}++/++__<path-to-git-repo>__
|
- `ftp[s]://<host>[:<port>]/<path-to-git-repo>`
|
||||||
|
|
||||||
An alternative scp-like syntax may also be used with the ssh protocol:
|
An alternative scp-like syntax may also be used with the ssh protocol:
|
||||||
|
|
||||||
- {startsb}__<user>__++@++{endsb}__<host>__++:/++__<path-to-git-repo>__
|
- `[<user>@]<host>:/<path-to-git-repo>`
|
||||||
|
|
||||||
This syntax is only recognized if there are no slashes before the
|
This syntax is only recognized if there are no slashes before the
|
||||||
first colon. This helps differentiate a local path that contains a
|
first colon. This helps differentiate a local path that contains a
|
||||||
|
@ -30,17 +30,17 @@ colon. For example the local path `foo:bar` could be specified as an
|
||||||
absolute path or `./foo:bar` to avoid being misinterpreted as an ssh
|
absolute path or `./foo:bar` to avoid being misinterpreted as an ssh
|
||||||
url.
|
url.
|
||||||
|
|
||||||
The ssh and git protocols additionally support ++~++__<username>__ expansion:
|
The ssh and git protocols additionally support `~<username>` expansion:
|
||||||
|
|
||||||
- ++ssh://++{startsb}__<user>__++@++{endsb}__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__
|
- `ssh://[<user>@]<host>[:<port>]/~<user>/<path-to-git-repo>`
|
||||||
- ++git://++__<host>__{startsb}++:++__<port>__{endsb}++/~++__<user>__++/++__<path-to-git-repo>__
|
- `git://<host>[:<port>]/~<user>/<path-to-git-repo>`
|
||||||
- {startsb}__<user>__++@++{endsb}__<host>__++:~++__<user>__++/++__<path-to-git-repo>__
|
- `[<user>@]<host>:~<user>/<path-to-git-repo>`
|
||||||
|
|
||||||
For local repositories, also supported by Git natively, the following
|
For local repositories, also supported by Git natively, the following
|
||||||
syntaxes may be used:
|
syntaxes may be used:
|
||||||
|
|
||||||
- `/path/to/repo.git/`
|
- `/path/to/repo.git/`
|
||||||
- ++file:///path/to/repo.git/++
|
- `file:///path/to/repo.git/`
|
||||||
|
|
||||||
ifndef::git-clone[]
|
ifndef::git-clone[]
|
||||||
These two syntaxes are mostly equivalent, except when cloning, when
|
These two syntaxes are mostly equivalent, except when cloning, when
|
||||||
|
@ -57,11 +57,11 @@ endif::git-clone[]
|
||||||
accept a suitable bundle file. See linkgit:git-bundle[1].
|
accept a suitable bundle file. See linkgit:git-bundle[1].
|
||||||
|
|
||||||
When Git doesn't know how to handle a certain transport protocol, it
|
When Git doesn't know how to handle a certain transport protocol, it
|
||||||
attempts to use the `remote-`{empty}__<transport>__ remote helper, if one
|
attempts to use the `remote-<transport>` remote helper, if one
|
||||||
exists. To explicitly request a remote helper, the following syntax
|
exists. To explicitly request a remote helper, the following syntax
|
||||||
may be used:
|
may be used:
|
||||||
|
|
||||||
- _<transport>_::__<address>__
|
- `<transport>::<address>`
|
||||||
|
|
||||||
where _<address>_ may be a path, a server and path, or an arbitrary
|
where _<address>_ may be a path, a server and path, or an arbitrary
|
||||||
URL-like string recognized by the specific remote helper being
|
URL-like string recognized by the specific remote helper being
|
||||||
|
|
Loading…
Reference in New Issue