mirror of
https://github.com/git/git.git
synced 2025-12-12 20:36:24 +01:00
Merge branch 'ja/doc-markup-fixes'
Mark-ups used in the documentation has been improved for consistency. * ja/doc-markup-fixes: doc: git-clone: format placeholders doc: git-clone: format verbatim words doc: git-init: rework config item init.templateDir doc: git-init: rework definition lists doc: git-init: format placeholders doc: git-init: format verbatim parts
This commit is contained in:
Junio C Hamano
@@ -1,7 +1,10 @@
|
||||
init.templateDir::
|
||||
Specify the directory from which templates will be copied.
|
||||
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
||||
:see-git-init:
|
||||
ifndef::git-init[]
|
||||
:see-git-init: (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
||||
endif::[]
|
||||
|
||||
init.templateDir::
|
||||
Specify the directory from which templates will be copied. {see-git-init}
|
||||
init.defaultBranch::
|
||||
Allows overriding the default branch name e.g. when initializing
|
||||
a new repository.
|
||||
|
||||
@@ -102,9 +102,9 @@ 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.
|
||||
|
||||
--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
|
||||
obtain objects from the reference repository. Using
|
||||
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.
|
||||
@@ -156,13 +156,13 @@ objects from the source repository into a pack in the cloned repository.
|
||||
|
||||
--[no-]reject-shallow::
|
||||
Fail if the source repository is a shallow repository.
|
||||
The 'clone.rejectShallow' configuration variable can be used to
|
||||
The `clone.rejectShallow` configuration variable can be used to
|
||||
specify the default.
|
||||
|
||||
--bare::
|
||||
Make a 'bare' Git repository. That is, instead of
|
||||
creating `<directory>` and placing the administrative
|
||||
files in `<directory>/.git`, make the `<directory>`
|
||||
creating _<directory>_ and placing the administrative
|
||||
files in `<directory>/.git`, make the _<directory>_
|
||||
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
|
||||
because there is nowhere to check out the working tree.
|
||||
Also the branch heads at the remote are copied directly
|
||||
@@ -180,11 +180,11 @@ objects from the source repository into a pack in the cloned repository.
|
||||
--filter=<filter-spec>::
|
||||
Use the partial clone feature and request that the server sends
|
||||
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
|
||||
filter out all blobs (file contents) until needed by Git. Also,
|
||||
`--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].
|
||||
|
||||
--also-filter-submodules::
|
||||
@@ -203,13 +203,13 @@ objects from the source repository into a pack in the cloned repository.
|
||||
-o <name>::
|
||||
--origin <name>::
|
||||
Instead of using the remote name `origin` to keep track of the upstream
|
||||
repository, use `<name>`. Overrides `clone.defaultRemoteName` from the
|
||||
repository, use _<name>_. Overrides `clone.defaultRemoteName` from the
|
||||
config.
|
||||
|
||||
-b <name>::
|
||||
--branch <name>::
|
||||
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
|
||||
be checked out.
|
||||
`--branch` can also take tags and detaches the HEAD at that commit
|
||||
@@ -230,7 +230,7 @@ objects from the source repository into a pack in the cloned repository.
|
||||
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
|
||||
files checked out. The _<key>_ is in the same format as expected by
|
||||
linkgit:git-config[1] (e.g., `core.eol=true`). 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
|
||||
@@ -263,7 +263,7 @@ corresponding `--mirror` and `--no-tags` options instead.
|
||||
branch remote's `HEAD` 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
|
||||
initial cloning. If the `HEAD` at the remote did not point at any
|
||||
branch when `--single-branch` clone was made, no remote-tracking
|
||||
branch is created.
|
||||
|
||||
@@ -281,7 +281,7 @@ branch of some repository for search indexing.
|
||||
|
||||
--recurse-submodules[=<pathspec>]::
|
||||
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.
|
||||
This option can be given multiple times for pathspecs consisting
|
||||
of multiple entries. The resulting clone has `submodule.active` set to
|
||||
@@ -323,20 +323,20 @@ include::ref-storage-format.txt[]
|
||||
Defaults to the `submodule.fetchJobs` option.
|
||||
|
||||
<repository>::
|
||||
The (possibly remote) repository to clone from. See the
|
||||
The (possibly remote) _<repository>_ to clone from. See the
|
||||
<<URLS,GIT URLS>> section below for more information on specifying
|
||||
repositories.
|
||||
|
||||
<directory>::
|
||||
The name of a new directory to clone into. The "humanish"
|
||||
part of the source repository is used if no directory is
|
||||
part of the source repository is used if no _<directory>_ is
|
||||
explicitly given (`repo` for `/path/to/repo.git` and `foo`
|
||||
for `host.xz:foo/.git`). Cloning into an existing directory
|
||||
is only allowed if the directory is empty.
|
||||
|
||||
--bundle-uri=<uri>::
|
||||
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/*`
|
||||
namespace. This option is incompatible with `--depth`,
|
||||
`--shallow-since`, and `--shallow-exclude`.
|
||||
|
||||
@@ -33,10 +33,10 @@ If the object storage directory is specified via the
|
||||
are created underneath; otherwise, the default `$GIT_DIR/objects`
|
||||
directory is used.
|
||||
|
||||
Running 'git init' in an existing repository is safe. It will not
|
||||
Running `git init` in an existing repository is safe. It will not
|
||||
overwrite things that are already there. The primary reason for
|
||||
rerunning 'git init' is to pick up newly added templates (or to move
|
||||
the repository to another place if --separate-git-dir is given).
|
||||
rerunning `git init` is to pick up newly added templates (or to move
|
||||
the repository to another place if `--separate-git-dir` is given).
|
||||
|
||||
OPTIONS
|
||||
-------
|
||||
@@ -53,14 +53,14 @@ current working directory.
|
||||
|
||||
--object-format=<format>::
|
||||
|
||||
Specify the given object format (hash algorithm) for the repository. The valid
|
||||
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
|
||||
Specify the given object _<format>_ (hash algorithm) for the repository. The valid
|
||||
values are `sha1` and (if enabled) `sha256`. `sha1` is the default.
|
||||
+
|
||||
include::object-format-disclaimer.txt[]
|
||||
|
||||
--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[]
|
||||
|
||||
@@ -81,7 +81,7 @@ If this is a reinitialization, the repository will be moved to the specified pat
|
||||
-b <branch-name>::
|
||||
--initial-branch=<branch-name>::
|
||||
|
||||
Use the specified 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
|
||||
`master`, but this is subject to change in the future; the name can be
|
||||
customized via the `init.defaultBranch` configuration variable).
|
||||
@@ -90,40 +90,44 @@ customized via the `init.defaultBranch` configuration variable).
|
||||
|
||||
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
|
||||
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).
|
||||
by `umask(2)`.
|
||||
+
|
||||
The option can have the following values, defaulting to 'group' if no value
|
||||
The option can have the following values, defaulting to `group` if no value
|
||||
is given:
|
||||
+
|
||||
--
|
||||
'umask' (or 'false')::
|
||||
umask::
|
||||
false::
|
||||
|
||||
Use permissions reported by umask(2). The default, when `--shared` is not
|
||||
specified.
|
||||
|
||||
'group' (or 'true')::
|
||||
group::
|
||||
true::
|
||||
|
||||
Make the repository group-writable, (and g+sx, since the git group may not be
|
||||
the primary group of all users). This is used to loosen the permissions of an
|
||||
otherwise safe umask(2) value. Note that the umask still applies to the other
|
||||
permission bits (e.g. if umask is '0022', using 'group' will not remove read
|
||||
privileges from other (non-group) users). See '0xxx' for how to exactly specify
|
||||
permission bits (e.g. if umask is `0022`, using `group` will not remove read
|
||||
privileges from other (non-group) users). See `0xxx` for how to exactly specify
|
||||
the repository permissions.
|
||||
|
||||
'all' (or 'world' or 'everybody')::
|
||||
all::
|
||||
world::
|
||||
everybody::
|
||||
|
||||
Same as 'group', but make the repository readable by all users.
|
||||
Same as `group`, but make the repository readable by all users.
|
||||
|
||||
'<perm>'::
|
||||
<perm>::
|
||||
|
||||
'<perm>' is a 3-digit octal number prefixed with `0` and each file
|
||||
will have mode '<perm>'. '<perm>' will override users' umask(2)
|
||||
value (and not only loosen permissions as 'group' and 'all'
|
||||
do). '0640' will create a repository which is group-readable, but
|
||||
not group-writable or accessible to others. '0660' will create a repo
|
||||
_<perm>_ is a 3-digit octal number prefixed with `0` and each file
|
||||
will have mode _<perm>_. _<perm>_ will override users'`umask(2)`
|
||||
value (and not only loosen permissions as `group` and `all`
|
||||
do). `0640` will create a repository which is group-readable, but
|
||||
not group-writable or accessible to others. `0660` will create a repo
|
||||
that is readable and writable to the current user and group, but
|
||||
inaccessible to others (directories and executable files get their
|
||||
`x` bit from the `r` bit for corresponding classes of users).
|
||||
@@ -133,7 +137,7 @@ By default, the configuration flag `receive.denyNonFastForwards` is enabled
|
||||
in shared repositories, so that you cannot force a non fast-forwarding push
|
||||
into it.
|
||||
|
||||
If you provide a 'directory', the command is run inside it. If this directory
|
||||
If you provide a _<directory>_, the command is run inside it. If this directory
|
||||
does not exist, it will be created.
|
||||
|
||||
TEMPLATE DIRECTORY
|
||||
@@ -172,7 +176,7 @@ $ git add . <2>
|
||||
$ git commit <3>
|
||||
----------------
|
||||
+
|
||||
<1> Create a /path/to/my/codebase/.git directory.
|
||||
<1> Create a `/path/to/my/codebase/.git` directory.
|
||||
<2> Add all existing files to the index.
|
||||
<3> Record the pristine state as the first commit in the history.
|
||||
|
||||
@@ -181,6 +185,8 @@ CONFIGURATION
|
||||
|
||||
include::includes/cmd-config-section-all.txt[]
|
||||
|
||||
:git-init:
|
||||
|
||||
include::config/init.txt[]
|
||||
|
||||
GIT
|
||||
|
||||
@@ -44,26 +44,26 @@ syntaxes may be used:
|
||||
|
||||
ifndef::git-clone[]
|
||||
These two syntaxes are mostly equivalent, except when cloning, when
|
||||
the former implies --local option. See linkgit:git-clone[1] for
|
||||
the former implies `--local` option. See linkgit:git-clone[1] for
|
||||
details.
|
||||
endif::git-clone[]
|
||||
|
||||
ifdef::git-clone[]
|
||||
These two syntaxes are mostly equivalent, except the former implies
|
||||
--local option.
|
||||
`--local` option.
|
||||
endif::git-clone[]
|
||||
|
||||
'git clone', 'git fetch' and 'git pull', but not 'git push', will also
|
||||
`git clone`, `git fetch` and `git pull`, but not `git push`, will also
|
||||
accept a suitable bundle file. See linkgit:git-bundle[1].
|
||||
|
||||
When Git doesn't know how to handle a certain transport protocol, it
|
||||
attempts to use the 'remote-<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
|
||||
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
|
||||
invoked. See linkgit:gitremote-helpers[7] for details.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user