Skip to content

Commit 12e6024

Browse files
pcloudsgitster
authored andcommitted
config.txt: move ssh.* to a separate file
Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent d3df427 commit 12e6024

File tree

2 files changed

+37
-36
lines changed

2 files changed

+37
-36
lines changed

Documentation/config.txt

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -621,42 +621,6 @@ Environment variable settings always override any matches. The URLs that are
621621
matched against are those given directly to Git commands. This means any URLs
622622
visited as a result of a redirection do not participate in matching.
623623

624-
ssh.variant::
625-
By default, Git determines the command line arguments to use
626-
based on the basename of the configured SSH command (configured
627-
using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
628-
the config setting `core.sshCommand`). If the basename is
629-
unrecognized, Git will attempt to detect support of OpenSSH
630-
options by first invoking the configured SSH command with the
631-
`-G` (print configuration) option and will subsequently use
632-
OpenSSH options (if that is successful) or no options besides
633-
the host and remote command (if it fails).
634-
+
635-
The config variable `ssh.variant` can be set to override this detection.
636-
Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
637-
`tortoiseplink`, `simple` (no options except the host and remote command).
638-
The default auto-detection can be explicitly requested using the value
639-
`auto`. Any other value is treated as `ssh`. This setting can also be
640-
overridden via the environment variable `GIT_SSH_VARIANT`.
641-
+
642-
The current command-line parameters used for each variant are as
643-
follows:
644-
+
645-
--
646-
647-
* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
648-
649-
* `simple` - [username@]host command
650-
651-
* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
652-
653-
* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
654-
655-
--
656-
+
657-
Except for the `simple` variant, command-line parameters are likely to
658-
change as git gains new features.
659-
660624
i18n.commitEncoding::
661625
Character encoding the commit messages are stored in; Git itself
662626
does not care per se, but this information is necessary e.g. when
@@ -1298,6 +1262,8 @@ splitIndex.sharedIndexExpire::
12981262
either created based on it or read from it.
12991263
See linkgit:git-update-index[1].
13001264

1265+
include::config/ssh.txt[]
1266+
13011267
status.relativePaths::
13021268
By default, linkgit:git-status[1] shows paths relative to the
13031269
current directory. Setting this variable to `false` shows paths

Documentation/config/ssh.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
ssh.variant::
2+
By default, Git determines the command line arguments to use
3+
based on the basename of the configured SSH command (configured
4+
using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or
5+
the config setting `core.sshCommand`). If the basename is
6+
unrecognized, Git will attempt to detect support of OpenSSH
7+
options by first invoking the configured SSH command with the
8+
`-G` (print configuration) option and will subsequently use
9+
OpenSSH options (if that is successful) or no options besides
10+
the host and remote command (if it fails).
11+
+
12+
The config variable `ssh.variant` can be set to override this detection.
13+
Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`,
14+
`tortoiseplink`, `simple` (no options except the host and remote command).
15+
The default auto-detection can be explicitly requested using the value
16+
`auto`. Any other value is treated as `ssh`. This setting can also be
17+
overridden via the environment variable `GIT_SSH_VARIANT`.
18+
+
19+
The current command-line parameters used for each variant are as
20+
follows:
21+
+
22+
--
23+
24+
* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command
25+
26+
* `simple` - [username@]host command
27+
28+
* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command
29+
30+
* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command
31+
32+
--
33+
+
34+
Except for the `simple` variant, command-line parameters are likely to
35+
change as git gains new features.

0 commit comments

Comments
 (0)