diff options
| author | Jean-Noël Avila <jn.avila@free.fr> | 2025-11-19 21:40:03 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2025-11-19 15:00:42 -0800 |
| commit | c80a5ebce0e6afe3f9d3f5047f3de524386c40bb (patch) | |
| tree | 6f444277753f5bb21db675dd98ac2c067691bf1a /Documentation/fetch-options.adoc | |
| parent | 903b04a3e721f4afb337bd48890b69e16c04c5d6 (diff) | |
| download | git-c80a5ebce0e6afe3f9d3f5047f3de524386c40bb.tar.xz | |
doc: convert git pull 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 <jn.avila@free.fr>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/fetch-options.adoc')
| -rw-r--r-- | Documentation/fetch-options.adoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/fetch-options.adoc b/Documentation/fetch-options.adoc index 35a84a1ef2..fcba46ee9e 100644 --- a/Documentation/fetch-options.adoc +++ b/Documentation/fetch-options.adoc @@ -71,7 +71,7 @@ configuration variables documented in linkgit:git-config[1], and the `--negotiate-only`:: Do not fetch anything from the server, and instead print the - ancestors of the provided `--negotiation-tip=*` arguments, + ancestors of the provided `--negotiation-tip=` arguments, which we have in common with the server. + This is incompatible with `--recurse-submodules=(yes|on-demand)`. @@ -126,7 +126,7 @@ ifndef::git-pull[] `--auto-gc`:: `--no-auto-gc`:: Run `git maintenance run --auto` at the end to perform automatic - repository maintenance if needed. (`--[no-]auto-gc` is a synonym.) + repository maintenance if needed. This is enabled by default. `--write-commit-graph`:: @@ -193,7 +193,7 @@ endif::git-pull[] specified refspec (can be given more than once) to map the refs to remote-tracking branches, instead of the values of `remote.<name>.fetch` configuration variables for the remote - repository. Providing an empty `<refspec>` to the + repository. Providing an empty _<refspec>_ to the `--refmap` option causes Git to ignore the configured refspecs and rely entirely on the refspecs supplied as command-line arguments. See section on "Configured Remote-tracking @@ -204,7 +204,7 @@ endif::git-pull[] Fetch all tags from the remote (i.e., fetch remote tags `refs/tags/*` into local tags with the same name), in addition to whatever else would otherwise be fetched. Using this - option alone does not subject tags to pruning, even if --prune + option alone does not subject tags to pruning, even if `--prune` is used (though tags may be pruned anyway if they are also the destination of an explicit refspec; see `--prune`). @@ -306,7 +306,7 @@ endif::git-pull[] `-o <option>`:: `--server-option=<option>`:: Transmit the given string to the server when communicating using - protocol version 2. The given string must not contain a NUL or LF + protocol version 2. The given string must not contain a _NUL_ or _LF_ character. The server's handling of server options, including unknown ones, is server-specific. When multiple `--server-option=<option>` are given, they are all |