doc: git-clone: format placeholders
With the new formatting rules, we use _<placeholders>_. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Mar 10, 2024 at 19:10 UTC
45d5ed3e50375a4b1c5d1bf49128aec975b0546d
2 files changed
+15
-15
Documentation/git-clone.txt
+13
-13
@@ -102,9 +102,9 @@ its source repository, you can simply run `git repack -a` to copy all
102
objects from the source repository into a pack in the cloned repository.
103
104
--reference[-if-able] <repository>::
105
- If the reference repository is on the local machine,
105
+ If the reference _<repository>_ is on the local machine,
106
automatically setup `.git/objects/info/alternates` to
107
- obtain objects from the reference repository. Using
107
+ obtain objects from the reference _<repository>_. Using
108
an already existing repository as an alternate will
109
require fewer objects to be copied from the repository
110
being cloned, reducing network and local storage costs.
@@ -161,8 +161,8 @@ objects from the source repository into a pack in the cloned repository.
161
162
--bare::
163
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>_
166
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
167
because there is nowhere to check out the working tree.
168
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.
180
--filter=<filter-spec>::
181
Use the partial clone feature and request that the server sends
182
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
184
the partial clone filter. For example, `--filter=blob:none` will
185
filter out all blobs (file contents) until needed by Git. Also,
186
`--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
188
the `--filter` option in linkgit:git-rev-list[1].
189
190
--also-filter-submodules::
@@ -203,13 +203,13 @@ objects from the source repository into a pack in the cloned repository.
203
-o <name>::
204
--origin <name>::
205
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
207
config.
208
209
-b <name>::
210
--branch <name>::
211
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
213
instead. In a non-bare repository, this is the branch that will
214
be checked out.
215
`--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.
230
Set a configuration variable in the newly-created repository;
231
this takes effect immediately after the repository is
232
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
234
linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
235
values are given for the same key, each value will be written to
236
the config file. This makes it safe, for example, to add
@@ -281,7 +281,7 @@ branch of some repository for search indexing.
281
282
--recurse-submodules[=<pathspec>]::
283
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
285
provided, all submodules are initialized and cloned.
286
This option can be given multiple times for pathspecs consisting
287
of multiple entries. The resulting clone has `submodule.active` set to
@@ -323,20 +323,20 @@ include::ref-storage-format.txt[]
323
Defaults to the `submodule.fetchJobs` option.
324
325
<repository>::
326
- The (possibly remote) repository to clone from. See the
326
+ The (possibly remote) _<repository>_ to clone from. See the
327
<<URLS,GIT URLS>> section below for more information on specifying
328
repositories.
329
330
<directory>::
331
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
333
explicitly given (`repo` for `/path/to/repo.git` and `foo`
334
for `host.xz:foo/.git`). Cloning into an existing directory
335
is only allowed if the directory is empty.
336
337
--bundle-uri=<uri>::
338
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
340
in the bundle will be stored under the hidden `refs/bundle/*`
341
namespace. This option is incompatible with `--depth`,
342
`--shallow-since`, and `--shallow-exclude`.
Documentation/urls.txt
+2
-2
@@ -61,9 +61,9 @@ attempts to use the `remote-<transport>` remote helper, if one
61
exists. To explicitly request a remote helper, the following syntax
62
may be used:
63
64
-- <transport>::<address>
64
+- _<transport>_::_<address>_
65
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
67
URL-like string recognized by the specific remote helper being
68
invoked. See linkgit:gitremote-helpers[7] for details.
69