Skip to content

Commit 2f64d40

Browse files
committed
doc: convert git fetch to synopsis 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]>
1 parent fd372d9 commit 2f64d40

File tree

5 files changed

+189
-188
lines changed

5 files changed

+189
-188
lines changed

Documentation/config/fetch.adoc

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
1-
fetch.recurseSubmodules::
1+
`fetch.recurseSubmodules`::
22
This option controls whether `git fetch` (and the underlying fetch
33
in `git pull`) will recursively fetch into populated submodules.
4-
This option can be set either to a boolean value or to 'on-demand'.
4+
This option can be set either to a boolean value or to `on-demand`.
55
Setting it to a boolean changes the behavior of fetch and pull to
66
recurse unconditionally into submodules when set to true or to not
7-
recurse at all when set to false. When set to 'on-demand', fetch and
7+
recurse at all when set to false. When set to `on-demand`, fetch and
88
pull will only recurse into a populated submodule when its
99
superproject retrieves a commit that updates the submodule's
1010
reference.
11-
Defaults to 'on-demand', or to the value of 'submodule.recurse' if set.
11+
Defaults to `on-demand`, or to the value of `submodule.recurse` if set.
1212

13-
fetch.fsckObjects::
13+
`fetch.fsckObjects`::
1414
If it is set to true, git-fetch-pack will check all fetched
1515
objects. See `transfer.fsckObjects` for what's
16-
checked. Defaults to false. If not set, the value of
16+
checked. Defaults to `false`. If not set, the value of
1717
`transfer.fsckObjects` is used instead.
1818

19-
fetch.fsck.<msg-id>::
19+
`fetch.fsck.<msg-id>`::
2020
Acts like `fsck.<msg-id>`, but is used by
2121
linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
2222
the `fsck.<msg-id>` documentation for details.
2323

24-
fetch.fsck.skipList::
24+
`fetch.fsck.skipList`::
2525
Acts like `fsck.skipList`, but is used by
2626
linkgit:git-fetch-pack[1] instead of linkgit:git-fsck[1]. See
2727
the `fsck.skipList` documentation for details.
2828

29-
fetch.unpackLimit::
29+
`fetch.unpackLimit`::
3030
If the number of objects fetched over the Git native
3131
transfer is below this
3232
limit, then the objects will be unpacked into loose object
@@ -37,54 +37,54 @@ fetch.unpackLimit::
3737
especially on slow filesystems. If not set, the value of
3838
`transfer.unpackLimit` is used instead.
3939

40-
fetch.prune::
40+
`fetch.prune`::
4141
If true, fetch will automatically behave as if the `--prune`
4242
option was given on the command line. See also `remote.<name>.prune`
4343
and the PRUNING section of linkgit:git-fetch[1].
4444

45-
fetch.pruneTags::
45+
`fetch.pruneTags`::
4646
If true, fetch will automatically behave as if the
4747
`refs/tags/*:refs/tags/*` refspec was provided when pruning,
4848
if not set already. This allows for setting both this option
4949
and `fetch.prune` to maintain a 1=1 mapping to upstream
5050
refs. See also `remote.<name>.pruneTags` and the PRUNING
5151
section of linkgit:git-fetch[1].
5252

53-
fetch.all::
53+
`fetch.all`::
5454
If true, fetch will attempt to update all available remotes.
5555
This behavior can be overridden by passing `--no-all` or by
5656
explicitly specifying one or more remote(s) to fetch from.
57-
Defaults to false.
57+
Defaults to `false`.
5858

59-
fetch.output::
59+
`fetch.output`::
6060
Control how ref update status is printed. Valid values are
6161
`full` and `compact`. Default value is `full`. See the
6262
OUTPUT section in linkgit:git-fetch[1] for details.
6363

64-
fetch.negotiationAlgorithm::
64+
`fetch.negotiationAlgorithm`::
6565
Control how information about the commits in the local repository
6666
is sent when negotiating the contents of the packfile to be sent by
67-
the server. Set to "consecutive" to use an algorithm that walks
68-
over consecutive commits checking each one. Set to "skipping" to
67+
the server. Set to `consecutive` to use an algorithm that walks
68+
over consecutive commits checking each one. Set to `skipping` to
6969
use an algorithm that skips commits in an effort to converge
7070
faster, but may result in a larger-than-necessary packfile; or set
71-
to "noop" to not send any information at all, which will almost
71+
to `noop` to not send any information at all, which will almost
7272
certainly result in a larger-than-necessary packfile, but will skip
73-
the negotiation step. Set to "default" to override settings made
73+
the negotiation step. Set to `default` to override settings made
7474
previously and use the default behaviour. The default is normally
75-
"consecutive", but if `feature.experimental` is true, then the
76-
default is "skipping". Unknown values will cause 'git fetch' to
75+
`consecutive`, but if `feature.experimental` is `true`, then the
76+
default is `skipping`. Unknown values will cause `git fetch` to
7777
error out.
7878
+
7979
See also the `--negotiate-only` and `--negotiation-tip` options to
8080
linkgit:git-fetch[1].
8181

82-
fetch.showForcedUpdates::
83-
Set to false to enable `--no-show-forced-updates` in
82+
`fetch.showForcedUpdates`::
83+
Set to `false` to enable `--no-show-forced-updates` in
8484
linkgit:git-fetch[1] and linkgit:git-pull[1] commands.
85-
Defaults to true.
85+
Defaults to `true`.
8686

87-
fetch.parallel::
87+
`fetch.parallel`::
8888
Specifies the maximal number of fetch operations to be run in parallel
8989
at a time (submodules, or remotes when the `--multiple` option of
9090
linkgit:git-fetch[1] is in effect).
@@ -94,16 +94,16 @@ A value of 0 will give some reasonable default. If unset, it defaults to 1.
9494
For submodules, this setting can be overridden using the `submodule.fetchJobs`
9595
config setting.
9696

97-
fetch.writeCommitGraph::
97+
`fetch.writeCommitGraph`::
9898
Set to true to write a commit-graph after every `git fetch` command
9999
that downloads a pack-file from a remote. Using the `--split` option,
100100
most executions will create a very small commit-graph file on top of
101101
the existing commit-graph file(s). Occasionally, these files will
102102
merge and the write may take longer. Having an updated commit-graph
103103
file helps performance of many Git commands, including `git merge-base`,
104-
`git push -f`, and `git log --graph`. Defaults to false.
104+
`git push -f`, and `git log --graph`. Defaults to `false`.
105105

106-
fetch.bundleURI::
106+
`fetch.bundleURI`::
107107
This value stores a URI for downloading Git object data from a bundle
108108
URI before performing an incremental fetch from the origin Git server.
109109
This is similar to how the `--bundle-uri` option behaves in
@@ -115,9 +115,9 @@ If you modify this value and your repository has a `fetch.bundleCreationToken`
115115
value, then remove that `fetch.bundleCreationToken` value before fetching from
116116
the new bundle URI.
117117

118-
fetch.bundleCreationToken::
118+
`fetch.bundleCreationToken`::
119119
When using `fetch.bundleURI` to fetch incrementally from a bundle
120-
list that uses the "creationToken" heuristic, this config value
120+
list that uses the "`creationToken`" heuristic, this config value
121121
stores the maximum `creationToken` value of the downloaded bundles.
122122
This value is used to prevent downloading bundles in the future
123123
if the advertised `creationToken` is not strictly larger than this

0 commit comments

Comments
 (0)