Skip to content

Commit 45d5ed3

Browse files
jnavilagitster
authored andcommitted
doc: git-clone: format placeholders
With the new formatting rules, we use _<placeholders>_. Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent d3717e1 commit 45d5ed3

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

Documentation/git-clone.txt

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ its source repository, you can simply run `git repack -a` to copy all
102102
objects from the source repository into a pack in the cloned repository.
103103

104104
--reference[-if-able] <repository>::
105-
If the reference repository is on the local machine,
105+
If the reference _<repository>_ is on the local machine,
106106
automatically setup `.git/objects/info/alternates` to
107-
obtain objects from the reference repository. Using
107+
obtain objects from the reference _<repository>_. Using
108108
an already existing repository as an alternate will
109109
require fewer objects to be copied from the repository
110110
being cloned, reducing network and local storage costs.
@@ -161,8 +161,8 @@ objects from the source repository into a pack in the cloned repository.
161161

162162
--bare::
163163
Make a 'bare' Git repository. That is, instead of
164-
creating `<directory>` and placing the administrative
165-
files in `<directory>/.git`, make the `<directory>`
164+
creating _<directory>_ and placing the administrative
165+
files in `<directory>/.git`, make the _<directory>_
166166
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
167167
because there is nowhere to check out the working tree.
168168
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.
180180
--filter=<filter-spec>::
181181
Use the partial clone feature and request that the server sends
182182
a subset of reachable objects according to a given object filter.
183-
When using `--filter`, the supplied `<filter-spec>` is used for
183+
When using `--filter`, the supplied _<filter-spec>_ is used for
184184
the partial clone filter. For example, `--filter=blob:none` will
185185
filter out all blobs (file contents) until needed by Git. Also,
186186
`--filter=blob:limit=<size>` will filter out all blobs of size
187-
at least `<size>`. For more details on filter specifications, see
187+
at least _<size>_. For more details on filter specifications, see
188188
the `--filter` option in linkgit:git-rev-list[1].
189189

190190
--also-filter-submodules::
@@ -203,13 +203,13 @@ objects from the source repository into a pack in the cloned repository.
203203
-o <name>::
204204
--origin <name>::
205205
Instead of using the remote name `origin` to keep track of the upstream
206-
repository, use `<name>`. Overrides `clone.defaultRemoteName` from the
206+
repository, use _<name>_. Overrides `clone.defaultRemoteName` from the
207207
config.
208208

209209
-b <name>::
210210
--branch <name>::
211211
Instead of pointing the newly created HEAD to the branch pointed
212-
to by the cloned repository's HEAD, point to `<name>` branch
212+
to by the cloned repository's HEAD, point to _<name>_ branch
213213
instead. In a non-bare repository, this is the branch that will
214214
be checked out.
215215
`--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.
230230
Set a configuration variable in the newly-created repository;
231231
this takes effect immediately after the repository is
232232
initialized, but before the remote history is fetched or any
233-
files checked out. The key is in the same format as expected by
233+
files checked out. The _<key>_ is in the same format as expected by
234234
linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
235235
values are given for the same key, each value will be written to
236236
the config file. This makes it safe, for example, to add
@@ -281,7 +281,7 @@ branch of some repository for search indexing.
281281

282282
--recurse-submodules[=<pathspec>]::
283283
After the clone is created, initialize and clone submodules
284-
within based on the provided pathspec. If no pathspec is
284+
within based on the provided _<pathspec>_. If no _=<pathspec>_ is
285285
provided, all submodules are initialized and cloned.
286286
This option can be given multiple times for pathspecs consisting
287287
of multiple entries. The resulting clone has `submodule.active` set to
@@ -323,20 +323,20 @@ include::ref-storage-format.txt[]
323323
Defaults to the `submodule.fetchJobs` option.
324324

325325
<repository>::
326-
The (possibly remote) repository to clone from. See the
326+
The (possibly remote) _<repository>_ to clone from. See the
327327
<<URLS,GIT URLS>> section below for more information on specifying
328328
repositories.
329329

330330
<directory>::
331331
The name of a new directory to clone into. The "humanish"
332-
part of the source repository is used if no directory is
332+
part of the source repository is used if no _<directory>_ is
333333
explicitly given (`repo` for `/path/to/repo.git` and `foo`
334334
for `host.xz:foo/.git`). Cloning into an existing directory
335335
is only allowed if the directory is empty.
336336

337337
--bundle-uri=<uri>::
338338
Before fetching from the remote, fetch a bundle from the given
339-
`<uri>` and unbundle the data into the local repository. The refs
339+
_<uri>_ and unbundle the data into the local repository. The refs
340340
in the bundle will be stored under the hidden `refs/bundle/*`
341341
namespace. This option is incompatible with `--depth`,
342342
`--shallow-since`, and `--shallow-exclude`.

Documentation/urls.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,9 @@ attempts to use the `remote-<transport>` remote helper, if one
6161
exists. To explicitly request a remote helper, the following syntax
6262
may be used:
6363

64-
- <transport>::<address>
64+
- _<transport>_::_<address>_
6565

66-
where <address> may be a path, a server and path, or an arbitrary
66+
where _<address>_ may be a path, a server and path, or an arbitrary
6767
URL-like string recognized by the specific remote helper being
6868
invoked. See linkgit:gitremote-helpers[7] for details.
6969

0 commit comments

Comments
 (0)