Skip to content

Commit 3d26ec1

Browse files
jnavilagitster
authored andcommitted
doc: convert git-checkout manpage to new style
- Switch the synopsis to a synopsis block which will automatically format placeholders in italics and keywords in monospace - Use _<placeholder>_ instead of <placeholder> in the description - Use `backticks` for keywords and more complex option descriptions. The new rendering engine will apply synopsis rules to these spans. Signed-off-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 845c48a commit 3d26ec1

File tree

2 files changed

+121
-121
lines changed

2 files changed

+121
-121
lines changed

Documentation/config/checkout.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
checkout.defaultRemote::
1+
`checkout.defaultRemote`::
22
When you run `git checkout <something>`
33
or `git switch <something>` and only have one
44
remote, it may implicitly fall back on checking out and
55
tracking e.g. `origin/<something>`. This stops working as soon
6-
as you have more than one remote with a `<something>`
6+
as you have more than one remote with a _<something>_
77
reference. This setting allows for setting the name of a
88
preferred remote that should always win when it comes to
99
disambiguation. The typical use-case is to set this to
@@ -12,31 +12,31 @@ checkout.defaultRemote::
1212
Currently this is used by linkgit:git-switch[1] and
1313
linkgit:git-checkout[1] when `git checkout <something>`
1414
or `git switch <something>`
15-
will checkout the `<something>` branch on another remote,
15+
will checkout the _<something>_ branch on another remote,
1616
and by linkgit:git-worktree[1] when `git worktree add` refers to a
1717
remote branch. This setting might be used for other checkout-like
1818
commands or functionality in the future.
1919

20-
checkout.guess::
20+
`checkout.guess`::
2121
Provides the default value for the `--guess` or `--no-guess`
2222
option in `git checkout` and `git switch`. See
2323
linkgit:git-switch[1] and linkgit:git-checkout[1].
2424

25-
checkout.workers::
25+
`checkout.workers`::
2626
The number of parallel workers to use when updating the working tree.
2727
The default is one, i.e. sequential execution. If set to a value less
2828
than one, Git will use as many workers as the number of logical cores
2929
available. This setting and `checkout.thresholdForParallelism` affect
3030
all commands that perform checkout. E.g. checkout, clone, reset,
3131
sparse-checkout, etc.
3232
+
33-
Note: Parallel checkout usually delivers better performance for repositories
33+
NOTE: Parallel checkout usually delivers better performance for repositories
3434
located on SSDs or over NFS. For repositories on spinning disks and/or machines
3535
with a small number of cores, the default sequential checkout often performs
3636
better. The size and compression level of a repository might also influence how
3737
well the parallel version performs.
3838

39-
checkout.thresholdForParallelism::
39+
`checkout.thresholdForParallelism`::
4040
When running parallel checkout with a small number of files, the cost
4141
of subprocess spawning and inter-process communication might outweigh
4242
the parallelization gains. This setting allows you to define the minimum

0 commit comments

Comments
 (0)