From: Junio C Hamano Date: Fri, 5 Jan 2018 21:28:09 +0000 (-0800) Subject: Merge branch 'db/doc-config-section-names-with-bs' X-Git-Tag: v2.16.0-rc1~8 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/fa62d0392b6f69e5c2ba0885bd85e670c28e9546?hp=-c Merge branch 'db/doc-config-section-names-with-bs' Doc update. * db/doc-config-section-names-with-bs: config.txt: document behavior of backslashes in subsections --- fa62d0392b6f69e5c2ba0885bd85e670c28e9546 diff --combined Documentation/config.txt index 64c1dbba94,a63b329ff4..0e25b2c92b --- a/Documentation/config.txt +++ b/Documentation/config.txt @@@ -41,11 -41,13 +41,13 @@@ in the section header, like in the exam -------- Subsection names are case sensitive and can contain any characters except - newline (doublequote `"` and backslash can be included by escaping them - as `\"` and `\\`, respectively). Section headers cannot span multiple - lines. Variables may belong directly to a section or to a given subsection. - You can have `[section]` if you have `[section "subsection"]`, but you - don't need to. + newline and the null byte. Doublequote `"` and backslash can be included + by escaping them as `\"` and `\\`, respectively. Backslashes preceding + other characters are dropped when reading; for example, `\t` is read as + `t` and `\0` is read as `0` Section headers cannot span multiple lines. + Variables may belong directly to a section or to a given subsection. You + can have `[section]` if you have `[section "subsection"]`, but you don't + need to. There is also a deprecated `[section.subsection]` syntax. With this syntax, the subsection name is converted to lower-case and is also @@@ -351,12 -353,6 +353,12 @@@ advice.*: addEmbeddedRepo:: Advice on what to do when you've accidentally added one git repo inside of another. + ignoredHook:: + Advice shown if an hook is ignored because the hook is not + set as executable. + waitingForEditor:: + Print a message to the terminal whenever Git is waiting for + editor input from the user. -- core.fileMode:: @@@ -419,13 -415,6 +421,13 @@@ core.protectNTFS: 8.3 "short" names. Defaults to `true` on Windows, and `false` elsewhere. +core.fsmonitor:: + If set, the value of this variable is used as a command which + will identify all files that may have changed since the + requested date/time. This information is used to speed up git by + avoiding unnecessary processing of files that have not changed. + See the "fsmonitor-watchman" section of linkgit:githooks[5]. + core.trustctime:: If false, the ctime differences between the index and the working tree are ignored; useful when the inode change time @@@ -1968,8 -1957,8 +1970,8 @@@ empty string http.sslVerify:: Whether to verify the SSL certificate when fetching or pushing - over HTTPS. Can be overridden by the `GIT_SSL_NO_VERIFY` environment - variable. + over HTTPS. Defaults to true. Can be overridden by the + `GIT_SSL_NO_VERIFY` environment variable. http.sslCert:: File containing the SSL certificate when fetching or pushing @@@ -2111,40 -2100,15 +2113,40 @@@ matched against are those given directl visited as a result of a redirection do not participate in matching. ssh.variant:: - Depending on the value of the environment variables `GIT_SSH` or - `GIT_SSH_COMMAND`, or the config setting `core.sshCommand`, Git - auto-detects whether to adjust its command-line parameters for use - with plink or tortoiseplink, as opposed to the default (OpenSSH). + By default, Git determines the command line arguments to use + based on the basename of the configured SSH command (configured + using the environment variable `GIT_SSH` or `GIT_SSH_COMMAND` or + the config setting `core.sshCommand`). If the basename is + unrecognized, Git will attempt to detect support of OpenSSH + options by first invoking the configured SSH command with the + `-G` (print configuration) option and will subsequently use + OpenSSH options (if that is successful) or no options besides + the host and remote command (if it fails). ++ +The config variable `ssh.variant` can be set to override this detection. +Valid values are `ssh` (to use OpenSSH options), `plink`, `putty`, +`tortoiseplink`, `simple` (no options except the host and remote command). +The default auto-detection can be explicitly requested using the value +`auto`. Any other value is treated as `ssh`. This setting can also be +overridden via the environment variable `GIT_SSH_VARIANT`. ++ +The current command-line parameters used for each variant are as +follows: + -The config variable `ssh.variant` can be set to override this auto-detection; -valid values are `ssh`, `plink`, `putty` or `tortoiseplink`. Any other value -will be treated as normal ssh. This setting can be overridden via the -environment variable `GIT_SSH_VARIANT`. +-- + +* `ssh` - [-p port] [-4] [-6] [-o option] [username@]host command + +* `simple` - [username@]host command + +* `plink` or `putty` - [-P port] [-4] [-6] [username@]host command + +* `tortoiseplink` - [-P port] [-4] [-6] -batch [username@]host command + +-- ++ +Except for the `simple` variant, command-line parameters are likely to +change as git gains new features. i18n.commitEncoding:: Character encoding the commit messages are stored in; Git itself @@@ -2572,23 -2536,6 +2574,23 @@@ The protocol names currently used by gi `hg` to allow the `git-remote-hg` helper) -- +protocol.version:: + Experimental. If set, clients will attempt to communicate with a + server using the specified protocol version. If unset, no + attempt will be made by the client to communicate using a + particular protocol version, this results in protocol version 0 + being used. + Supported versions: ++ +-- + +* `0` - the original wire protocol. + +* `1` - the original wire protocol with the addition of a version string + in the initial response from the server. + +-- + pull.ff:: By default, Git does not create an extra merge commit when merging a commit that is a descendant of the current commit. Instead, the @@@ -2693,35 -2640,6 +2695,35 @@@ push.gpgSign: override a value from a lower-priority config file. An explicit command-line flag always overrides this config option. +push.pushOption:: + When no `--push-option=