Skip to content

Commit fe928fe

Browse files
committed
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>
1 parent 41aefe8 commit fe928fe

File tree

3 files changed

+30
-30
lines changed

3 files changed

+30
-30
lines changed

Documentation/for-each-ref-options.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ TAB %(refname)`.
3030

3131
`--color[=<when>]`::
3232
Respect any colors specified in the `--format` option. The
33-
_<when__ field must be one of `always`, `never`, or `auto` (if
34-
`<when>` is absent, behave as if `always` was given).
33+
_<when>_ field must be one of `always`, `never`, or `auto` (if
34+
_<when>_ is absent, behave as if `always` was given).
3535

3636
`--shell`::
3737
`--perl`::

Documentation/git-clone.adoc

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ _<src>_.
8484
with the source repository. The resulting repository
8585
starts out without any object of its own.
8686
+
87-
*NOTE*: this is a possibly dangerous operation; do *not* use
87+
NOTE: this is a possibly dangerous operation; do *not* use
8888
it unless you understand what it does. If you clone your
8989
repository using this option and then delete branches (or use any
9090
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
104104
its source repository, you can simply run `git repack -a` to copy all
105105
objects from the source repository into a pack in the cloned repository.
106106

107-
`--reference[-if-able] <repository>`::
107+
`--reference=<repository>`::
108+
`--reference-if-able=<repository>`::
108109
If the reference _<repository>_ is on the local machine,
109110
automatically setup `.git/objects/info/alternates` to
110111
obtain objects from the reference _<repository>_. Using
@@ -115,7 +116,7 @@ objects from the source repository into a pack in the cloned repository.
115116
directory is skipped with a warning instead of aborting
116117
the clone.
117118
+
118-
*NOTE*: see the NOTE for the `--shared` option, and also the
119+
NOTE: see the NOTE for the `--shared` option, and also the
119120
`--dissociate` option.
120121

121122
`--dissociate`::
@@ -140,14 +141,14 @@ objects from the source repository into a pack in the cloned repository.
140141
to the standard error stream.
141142

142143
`--progress`::
143-
Progress status is reported on the standard error stream
144-
by default when it is attached to a terminal, unless `--quiet`
144+
Report progress status on the standard error stream
145+
by default when attached to a terminal, unless `--quiet`
145146
is specified. This flag forces progress status even if the
146147
standard error stream is not directed to a terminal.
147148

148149
`--server-option=<option>`::
149150
Transmit the given string to the server when communicating using
150-
protocol version 2. The given string must not contain a NUL or LF
151+
protocol version 2. The given string must not contain a _NUL_ or _LF_
151152
character. The server's handling of server options, including
152153
unknown ones, is server-specific.
153154
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.
158159

159160
`-n`::
160161
`--no-checkout`::
161-
No checkout of `HEAD` is performed after the clone is complete.
162+
Do not checkout `HEAD` after the clone is complete.
162163

163-
`--`[`no-`]`reject-shallow`::
164+
`--no-reject-shallow`::
165+
`--reject-shallow`::
164166
Fail if the source repository is a shallow repository.
165167
The `clone.rejectShallow` configuration variable can be used to
166168
specify the default.
@@ -206,18 +208,17 @@ objects from the source repository into a pack in the cloned repository.
206208
that all these refs are overwritten by a `git remote update` in the
207209
target repository.
208210

209-
`-o <name>`::
210-
`--origin <name>`::
211+
`-o<name>`::
212+
`--origin=<name>`::
211213
Instead of using the remote name `origin` to keep track of the upstream
212214
repository, use _<name>_. Overrides `clone.defaultRemoteName` from the
213215
config.
214216

215-
`-b <name>`::
216-
`--branch <name>`::
217-
Instead of pointing the newly created `HEAD` to the branch pointed
218-
to by the cloned repository's `HEAD`, point to _<name>_ branch
219-
instead. In a non-bare repository, this is the branch that will
220-
be checked out.
217+
`-b<name>`::
218+
`--branch=<name>`::
219+
Point the newly created `HEAD` to _<name>_ branch instead of the branch
220+
pointed to by the cloned repository's `HEAD`. In a non-bare repository,
221+
this is the branch that will be checked out.
221222
`--branch` can also take tags and detaches the `HEAD` at that commit
222223
in the resulting repository.
223224

@@ -230,18 +231,17 @@ objects from the source repository into a pack in the cloned repository.
230231
name.
231232
This option is incompatible with `--branch` and `--mirror`.
232233

233-
`-u <upload-pack>`::
234-
`--upload-pack <upload-pack>`::
235-
When given, and the repository to clone from is accessed
236-
via ssh, this specifies a non-default path for the command
237-
run on the other end.
234+
`-u<upload-pack>`::
235+
`--upload-pack=<upload-pack>`::
236+
Specify a non-default path for the command run on the other end when the
237+
repository to clone from is accessed via ssh.
238238

239239
`--template=<template-directory>`::
240240
Specify the directory from which templates will be used;
241241
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
242242

243-
`-c <key>=<value>`::
244-
`--config <key>=<value>`::
243+
`-c<key>=<value>`::
244+
`--config=<key>=<value>`::
245245
Set a configuration variable in the newly-created repository;
246246
this takes effect immediately after the repository is
247247
initialized, but before the remote history is fetched or any
@@ -257,7 +257,7 @@ Configuration variables known to not take effect are:
257257
`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
258258
corresponding `--mirror` and `--no-tags` options instead.
259259

260-
`--depth <depth>`::
260+
`--depth=<depth>`::
261261
Create a 'shallow' clone with a history truncated to the
262262
specified number of commits. Implies `--single-branch` unless
263263
`--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:
339339
+
340340
include::ref-storage-format.adoc[]
341341

342-
`-j <n>`::
343-
`--jobs <n>`::
342+
`-j<n>`::
343+
`--jobs=<n>`::
344344
The number of submodules fetched at the same time.
345345
Defaults to the `submodule.fetchJobs` option.
346346

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
* `files` for loose files with packed-refs. This is the default.
2-
* `reftable` for the reftable format. This format is experimental and its
1+
`files`;; for loose files with packed-refs. This is the default.
2+
`reftable`;; for the reftable format. This format is experimental and its
33
internals are subject to change.

0 commit comments

Comments
 (0)