mirror of
https://github.com/git/git.git
synced 2026-02-25 17:33:34 +00:00
doc: fix some style issues in git-clone and for-each-ref-options
* spell out all forms of --[no-]reject-shallow in git-clone * use imperative mood for the first line of options * Use asciidoc NOTE macro * fix markups Reviewed-by: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
committed by
Junio C Hamano
parent
4f29c68534
commit
ccaca2c475
@@ -30,8 +30,8 @@ TAB %(refname)`.
|
||||
|
||||
`--color[=<when>]`::
|
||||
Respect any colors specified in the `--format` option. The
|
||||
_<when__ field must be one of `always`, `never`, or `auto` (if
|
||||
`<when>` is absent, behave as if `always` was given).
|
||||
_<when>_ field must be one of `always`, `never`, or `auto` (if
|
||||
_<when>_ is absent, behave as if `always` was given).
|
||||
|
||||
`--shell`::
|
||||
`--perl`::
|
||||
|
||||
@@ -84,7 +84,7 @@ _<src>_.
|
||||
with the source repository. The resulting repository
|
||||
starts out without any object of its own.
|
||||
+
|
||||
*NOTE*: this is a possibly dangerous operation; do *not* use
|
||||
NOTE: this is a possibly dangerous operation; do *not* use
|
||||
it unless you understand what it does. If you clone your
|
||||
repository using this option and then delete branches (or use any
|
||||
other Git command that makes any existing commit unreferenced) in the
|
||||
@@ -104,7 +104,8 @@ 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
|
||||
objects from the source repository into a pack in the cloned repository.
|
||||
|
||||
`--reference[-if-able] <repository>`::
|
||||
`--reference=<repository>`::
|
||||
`--reference-if-able=<repository>`::
|
||||
If the reference _<repository>_ is on the local machine,
|
||||
automatically setup `.git/objects/info/alternates` to
|
||||
obtain objects from the reference _<repository>_. Using
|
||||
@@ -115,7 +116,7 @@ objects from the source repository into a pack in the cloned repository.
|
||||
directory is skipped with a warning instead of aborting
|
||||
the clone.
|
||||
+
|
||||
*NOTE*: see the NOTE for the `--shared` option, and also the
|
||||
NOTE: see the NOTE for the `--shared` option, and also the
|
||||
`--dissociate` option.
|
||||
|
||||
`--dissociate`::
|
||||
@@ -140,14 +141,14 @@ objects from the source repository into a pack in the cloned repository.
|
||||
to the standard error stream.
|
||||
|
||||
`--progress`::
|
||||
Progress status is reported on the standard error stream
|
||||
by default when it is attached to a terminal, unless `--quiet`
|
||||
Report progress status on the standard error stream
|
||||
by default when attached to a terminal, unless `--quiet`
|
||||
is specified. This flag forces progress status even if the
|
||||
standard error stream is not directed to a terminal.
|
||||
|
||||
`--server-option=<option>`::
|
||||
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
|
||||
unknown ones, is server-specific.
|
||||
When multiple `--server-option=<option>` are given, they are all
|
||||
@@ -158,9 +159,10 @@ objects from the source repository into a pack in the cloned repository.
|
||||
|
||||
`-n`::
|
||||
`--no-checkout`::
|
||||
No checkout of `HEAD` is performed after the clone is complete.
|
||||
Do not checkout `HEAD` after the clone is complete.
|
||||
|
||||
`--`[`no-`]`reject-shallow`::
|
||||
`--no-reject-shallow`::
|
||||
`--reject-shallow`::
|
||||
Fail if the source repository is a shallow repository.
|
||||
The `clone.rejectShallow` configuration variable can be used to
|
||||
specify the default.
|
||||
@@ -206,18 +208,17 @@ objects from the source repository into a pack in the cloned repository.
|
||||
that all these refs are overwritten by a `git remote update` in the
|
||||
target repository.
|
||||
|
||||
`-o <name>`::
|
||||
`--origin <name>`::
|
||||
`-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
|
||||
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
|
||||
instead. In a non-bare repository, this is the branch that will
|
||||
be checked out.
|
||||
`-b<name>`::
|
||||
`--branch=<name>`::
|
||||
Point the newly created `HEAD` to _<name>_ branch instead of the branch
|
||||
pointed to by the cloned repository's `HEAD`. 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
|
||||
in the resulting repository.
|
||||
|
||||
@@ -230,18 +231,17 @@ objects from the source repository into a pack in the cloned repository.
|
||||
name.
|
||||
This option is incompatible with `--branch` and `--mirror`.
|
||||
|
||||
`-u <upload-pack>`::
|
||||
`--upload-pack <upload-pack>`::
|
||||
When given, and the repository to clone from is accessed
|
||||
via ssh, this specifies a non-default path for the command
|
||||
run on the other end.
|
||||
`-u<upload-pack>`::
|
||||
`--upload-pack=<upload-pack>`::
|
||||
Specify a non-default path for the command run on the other end when the
|
||||
repository to clone from is accessed via ssh.
|
||||
|
||||
`--template=<template-directory>`::
|
||||
Specify the directory from which templates will be used;
|
||||
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
||||
|
||||
`-c <key>=<value>`::
|
||||
`--config <key>=<value>`::
|
||||
`-c<key>=<value>`::
|
||||
`--config=<key>=<value>`::
|
||||
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
|
||||
@@ -257,7 +257,7 @@ Configuration variables known to not take effect are:
|
||||
`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
|
||||
corresponding `--mirror` and `--no-tags` options instead.
|
||||
|
||||
`--depth <depth>`::
|
||||
`--depth=<depth>`::
|
||||
Create a 'shallow' clone with a history truncated to the
|
||||
specified number of commits. Implies `--single-branch` unless
|
||||
`--no-single-branch` is given to fetch the histories near the
|
||||
@@ -339,8 +339,8 @@ Specify the given ref storage format for the repository. The valid values are:
|
||||
+
|
||||
include::ref-storage-format.adoc[]
|
||||
|
||||
`-j <n>`::
|
||||
`--jobs <n>`::
|
||||
`-j<n>`::
|
||||
`--jobs=<n>`::
|
||||
The number of submodules fetched at the same time.
|
||||
Defaults to the `submodule.fetchJobs` option.
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
* `files` for loose files with packed-refs. This is the default.
|
||||
* `reftable` for the reftable format. This format is experimental and its
|
||||
`files`;; for loose files with packed-refs. This is the default.
|
||||
`reftable`;; for the reftable format. This format is experimental and its
|
||||
internals are subject to change.
|
||||
|
||||
Reference in New Issue
Block a user