diff options
Diffstat (limited to 'third_party/git/Documentation/config')
22 files changed, 30 insertions, 211 deletions
diff --git a/third_party/git/Documentation/config/add.txt b/third_party/git/Documentation/config/add.txt index c9f748f81cb1..4d753f006ec1 100644 --- a/third_party/git/Documentation/config/add.txt +++ b/third_party/git/Documentation/config/add.txt @@ -5,8 +5,3 @@ add.ignore-errors (deprecated):: option of linkgit:git-add[1]. `add.ignore-errors` is deprecated, as it does not follow the usual naming convention for configuration variables. - -add.interactive.useBuiltin:: - [EXPERIMENTAL] Set to `true` to use the experimental built-in - implementation of the interactive version of linkgit:git-add[1] - instead of the Perl script version. Is `false` by default. diff --git a/third_party/git/Documentation/config/advice.txt b/third_party/git/Documentation/config/advice.txt index bdd37c3eaa32..6aaa36020298 100644 --- a/third_party/git/Documentation/config/advice.txt +++ b/third_party/git/Documentation/config/advice.txt @@ -107,13 +107,4 @@ advice.*:: editor input from the user. nestedTag:: Advice shown if a user attempts to recursively tag a tag object. - submoduleAlternateErrorStrategyDie:: - Advice shown when a submodule.alternateErrorStrategy option - configured to "die" causes a fatal error. - addIgnoredFile:: - Advice shown if a user attempts to add an ignored file to - the index. - addEmptyPathspec:: - Advice shown if a user runs the add command without providing - the pathspec parameter. -- diff --git a/third_party/git/Documentation/config/branch.txt b/third_party/git/Documentation/config/branch.txt index cc5f3249fc58..a592d522a744 100644 --- a/third_party/git/Documentation/config/branch.txt +++ b/third_party/git/Documentation/config/branch.txt @@ -81,16 +81,15 @@ branch.<name>.rebase:: "git pull" is run. See "pull.rebase" for doing this in a non branch-specific manner. + -When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase' +When `merges`, pass the `--rebase-merges` option to 'git rebase' so that the local merge commits are included in the rebase (see linkgit:git-rebase[1] for details). + -When `preserve` (or just 'p', deprecated in favor of `merges`), also pass +When `preserve` (deprecated in favor of `merges`), also pass `--preserve-merges` along to 'git rebase' so that locally committed merge commits will not be flattened by running 'git pull'. + -When the value is `interactive` (or just 'i'), the rebase is run in interactive -mode. +When the value is `interactive`, the rebase is run in interactive mode. + *NOTE*: this is a possibly dangerous operation; do *not* use it unless you understand the implications (see linkgit:git-rebase[1] diff --git a/third_party/git/Documentation/config/core.txt b/third_party/git/Documentation/config/core.txt index 74619a9c03bb..75538d27e7e0 100644 --- a/third_party/git/Documentation/config/core.txt +++ b/third_party/git/Documentation/config/core.txt @@ -68,17 +68,6 @@ core.fsmonitor:: avoiding unnecessary processing of files that have not changed. See the "fsmonitor-watchman" section of linkgit:githooks[5]. -core.fsmonitorHookVersion:: - Sets the version of hook that is to be used when calling fsmonitor. - There are currently versions 1 and 2. When this is not set, - version 2 will be tried first and if it fails then version 1 - will be tried. Version 1 uses a timestamp as input to determine - which files have changes since that time but some monitors - like watchman have race conditions when used with a timestamp. - Version 2 uses an opaque string so that the monitor can return - something that can be used to determine what files have changed - without race conditions. - core.trustctime:: If false, the ctime differences between the index and the working tree are ignored; useful when the inode change time @@ -97,9 +86,7 @@ core.untrackedCache:: it will automatically be removed, if set to `false`. Before setting it to `true`, you should check that mtime is working properly on your system. - See linkgit:git-update-index[1]. `keep` by default, unless - `feature.manyFiles` is enabled which sets this setting to - `true` by default. + See linkgit:git-update-index[1]. `keep` by default. core.checkStat:: When missing or is set to `default`, many fields in the stat @@ -570,12 +557,6 @@ core.unsetenvvars:: Defaults to `PERL5LIB` to account for the fact that Git for Windows insists on using its own Perl interpreter. -core.restrictinheritedhandles:: - Windows-only: override whether spawned processes inherit only standard - file handles (`stdin`, `stdout` and `stderr`) or all handles. Can be - `auto`, `true` or `false`. Defaults to `auto`, which means `true` on - Windows 7 and later, and `false` on older Windows versions. - core.createObject:: You can set this to 'link', in which case a hardlink followed by a delete of the source are used to make sure that object creation @@ -596,7 +577,7 @@ the `GIT_NOTES_REF` environment variable. See linkgit:git-notes[1]. core.commitGraph:: If true, then git will read the commit-graph file (if it exists) - to parse the graph structure of commits. Defaults to true. See + to parse the graph structure of commits. Defaults to false. See linkgit:git-commit-graph[1] for more information. core.useReplaceRefs:: @@ -610,14 +591,8 @@ core.multiPackIndex:: multi-pack-index design document]. core.sparseCheckout:: - Enable "sparse checkout" feature. See linkgit:git-sparse-checkout[1] - for more information. - -core.sparseCheckoutCone:: - Enables the "cone mode" of the sparse checkout feature. When the - sparse-checkout file contains a limited set of patterns, then this - mode provides significant performance advantages. See - linkgit:git-sparse-checkout[1] for more information. + Enable "sparse checkout" feature. See section "Sparse checkout" in + linkgit:git-read-tree[1] for more information. core.abbrev:: Set the length object names are abbreviated to. If diff --git a/third_party/git/Documentation/config/diff.txt b/third_party/git/Documentation/config/diff.txt index ff09f1cf737c..5afb5a2cbc69 100644 --- a/third_party/git/Documentation/config/diff.txt +++ b/third_party/git/Documentation/config/diff.txt @@ -189,7 +189,7 @@ diff.guitool:: include::../mergetools-diff.txt[] diff.indentHeuristic:: - Set this option to `false` to disable the default heuristics + Set this option to `true` to enable experimental heuristics that shift diff hunk boundaries to make patches easier to read. diff.algorithm:: diff --git a/third_party/git/Documentation/config/feature.txt b/third_party/git/Documentation/config/feature.txt deleted file mode 100644 index 875f8c8a66f3..000000000000 --- a/third_party/git/Documentation/config/feature.txt +++ /dev/null @@ -1,37 +0,0 @@ -feature.*:: - The config settings that start with `feature.` modify the defaults of - a group of other config settings. These groups are created by the Git - developer community as recommended defaults and are subject to change. - In particular, new config options may be added with different defaults. - -feature.experimental:: - Enable config options that are new to Git, and are being considered for - future defaults. Config settings included here may be added or removed - with each release, including minor version updates. These settings may - have unintended interactions since they are so new. Please enable this - setting if you are interested in providing feedback on experimental - features. The new default values are: -+ -* `pack.useSparse=true` uses a new algorithm when constructing a pack-file -which can improve `git push` performance in repos with many files. -+ -* `fetch.negotiationAlgorithm=skipping` may improve fetch negotiation times by -skipping more commits at a time, reducing the number of round trips. -+ -* `fetch.writeCommitGraph=true` writes a commit-graph after every `git fetch` -command that downloads a pack-file from a remote. Using the `--split` option, -most executions will create a very small commit-graph file on top of the -existing commit-graph file(s). Occasionally, these files will merge and the -write may take longer. Having an updated commit-graph file helps performance -of many Git commands, including `git merge-base`, `git push -f`, and -`git log --graph`. - -feature.manyFiles:: - Enable config options that optimize for repos with many files in the - working directory. With many files, commands such as `git status` and - `git checkout` may be slow and these new defaults improve performance: -+ -* `index.version=4` enables path-prefix compression in the index. -+ -* `core.untrackedCache=true` enables the untracked cache. This setting assumes -that mtime is working on your machine. diff --git a/third_party/git/Documentation/config/fetch.txt b/third_party/git/Documentation/config/fetch.txt index f11940280fe3..ba890b5884fc 100644 --- a/third_party/git/Documentation/config/fetch.txt +++ b/third_party/git/Documentation/config/fetch.txt @@ -59,8 +59,7 @@ fetch.negotiationAlgorithm:: effort to converge faster, but may result in a larger-than-necessary packfile; The default is "default" which instructs Git to use the default algorithm that never skips commits (unless the server has acknowledged it or one - of its descendants). If `feature.experimental` is enabled, then this - setting defaults to "skipping". + of its descendants). Unknown values will cause 'git fetch' to error out. + See also the `--negotiation-tip` option for linkgit:git-fetch[1]. @@ -69,23 +68,3 @@ fetch.showForcedUpdates:: Set to false to enable `--no-show-forced-updates` in linkgit:git-fetch[1] and linkgit:git-pull[1] commands. Defaults to true. - -fetch.parallel:: - Specifies the maximal number of fetch operations to be run in parallel - at a time (submodules, or remotes when the `--multiple` option of - linkgit:git-fetch[1] is in effect). -+ -A value of 0 will give some reasonable default. If unset, it defaults to 1. -+ -For submodules, this setting can be overridden using the `submodule.fetchJobs` -config setting. - -fetch.writeCommitGraph:: - Set to true to write a commit-graph after every `git fetch` command - that downloads a pack-file from a remote. Using the `--split` option, - most executions will create a very small commit-graph file on top of - the existing commit-graph file(s). Occasionally, these files will - merge and the write may take longer. Having an updated commit-graph - file helps performance of many Git commands, including `git merge-base`, - `git push -f`, and `git log --graph`. Defaults to false, unless - `feature.experimental` is true. diff --git a/third_party/git/Documentation/config/format.txt b/third_party/git/Documentation/config/format.txt index 45c7bd5a8ff8..414a5a8a9d7d 100644 --- a/third_party/git/Documentation/config/format.txt +++ b/third_party/git/Documentation/config/format.txt @@ -36,12 +36,6 @@ format.subjectPrefix:: The default for format-patch is to output files with the '[PATCH]' subject prefix. Use this variable to change that prefix. -format.coverFromDescription:: - The default mode for format-patch to determine which parts of - the cover letter will be populated using the branch's - description. See the `--cover-from-description` option in - linkgit:git-format-patch[1]. - format.signature:: The default for format-patch is to output a signature containing the Git version number. Use this variable to change that default. @@ -83,11 +77,10 @@ format.coverLetter:: A boolean that controls whether to generate a cover-letter when format-patch is invoked, but in addition can be set to "auto", to generate a cover-letter only when there's more than one patch. - Default is false. format.outputDirectory:: Set a custom directory to store the resulting files instead of the - current working directory. All directory components will be created. + current working directory. format.useAutoBase:: A boolean value which lets you enable the `--base=auto` option of @@ -106,20 +99,4 @@ If one wishes to use the ref `ref/notes/true`, please use that literal instead. + This configuration can be specified multiple times in order to allow -multiple notes refs to be included. In that case, it will behave -similarly to multiple `--[no-]notes[=]` options passed in. That is, a -value of `true` will show the default notes, a value of `<ref>` will -also show notes from that notes ref and a value of `false` will negate -previous configurations and not show notes. -+ -For example, -+ ------------- -[format] - notes = true - notes = foo - notes = false - notes = bar ------------- -+ -will only show notes from `refs/notes/bar`. +multiple notes refs to be included. diff --git a/third_party/git/Documentation/config/gc.txt b/third_party/git/Documentation/config/gc.txt index 00ea0a678ee2..02b92b18b5c2 100644 --- a/third_party/git/Documentation/config/gc.txt +++ b/third_party/git/Documentation/config/gc.txt @@ -63,7 +63,7 @@ gc.writeCommitGraph:: If true, then gc will rewrite the commit-graph file when linkgit:git-gc[1] is run. When using `git gc --auto` the commit-graph will be updated if housekeeping is - required. Default is true. See linkgit:git-commit-graph[1] + required. Default is false. See linkgit:git-commit-graph[1] for details. gc.logExpiry:: diff --git a/third_party/git/Documentation/config/gpg.txt b/third_party/git/Documentation/config/gpg.txt index d94025cb3684..cce2c8924598 100644 --- a/third_party/git/Documentation/config/gpg.txt +++ b/third_party/git/Documentation/config/gpg.txt @@ -18,18 +18,3 @@ gpg.<format>.program:: chose. (see `gpg.program` and `gpg.format`) `gpg.program` can still be used as a legacy synonym for `gpg.openpgp.program`. The default value for `gpg.x509.program` is "gpgsm". - -gpg.minTrustLevel:: - Specifies a minimum trust level for signature verification. If - this option is unset, then signature verification for merge - operations require a key with at least `marginal` trust. Other - operations that perform signature verification require a key - with at least `undefined` trust. Setting this option overrides - the required trust-level for all operations. Supported values, - in increasing order of significance: -+ -* `undefined` -* `never` -* `marginal` -* `fully` -* `ultimate` diff --git a/third_party/git/Documentation/config/http.txt b/third_party/git/Documentation/config/http.txt index e806033aab86..5a32f5b0a5a9 100644 --- a/third_party/git/Documentation/config/http.txt +++ b/third_party/git/Documentation/config/http.txt @@ -71,7 +71,7 @@ http.saveCookies:: http.version:: Use the specified HTTP protocol version when communicating with a server. If you want to force the default. The available and default version depend - on libcurl. Currently the possible values of + on libcurl. Actually the possible values of this option are: - HTTP/2 @@ -84,7 +84,7 @@ http.sslVersion:: particular configuration of the crypto library in use. Internally this sets the 'CURLOPT_SSL_VERSION' option; see the libcurl documentation for more details on the format of this option and - for the ssl version supported. Currently the possible values of + for the ssl version supported. Actually the possible values of this option are: - sslv2 @@ -199,14 +199,6 @@ http.postBuffer:: Transfer-Encoding: chunked is used to avoid creating a massive pack file locally. Default is 1 MiB, which is sufficient for most requests. -+ -Note that raising this limit is only effective for disabling chunked -transfer encoding and therefore should be used only where the remote -server or a proxy only supports HTTP/1.0 or is noncompliant with the -HTTP standard. Raising this is not, in general, an effective solution -for most push problems, but can increase memory consumption -significantly since the entire buffer is allocated even for small -pushes. http.lowSpeedLimit, http.lowSpeedTime:: If the HTTP transfer speed is less than 'http.lowSpeedLimit' diff --git a/third_party/git/Documentation/config/index.txt b/third_party/git/Documentation/config/index.txt index 7cb50b37e98d..f18150304106 100644 --- a/third_party/git/Documentation/config/index.txt +++ b/third_party/git/Documentation/config/index.txt @@ -24,4 +24,3 @@ index.threads:: index.version:: Specify the version with which new index files should be initialized. This does not affect existing repositories. - If `feature.manyFiles` is enabled, then the default is 4. diff --git a/third_party/git/Documentation/config/pack.txt b/third_party/git/Documentation/config/pack.txt index 0dac5805816f..9cdcfa732478 100644 --- a/third_party/git/Documentation/config/pack.txt +++ b/third_party/git/Documentation/config/pack.txt @@ -27,13 +27,6 @@ Note that changing the compression level will not automatically recompress all existing objects. You can force recompression by passing the -F option to linkgit:git-repack[1]. -pack.allowPackReuse:: - When true, and when reachability bitmaps are enabled, - pack-objects will try to send parts of the bitmapped packfile - verbatim. This can reduce memory and CPU usage to serve fetches, - but might result in sending a slightly larger pack. Defaults to - true. - pack.island:: An extended regular expression configuring a set of delta islands. See "DELTA ISLANDS" in linkgit:git-pack-objects[1] @@ -119,8 +112,7 @@ pack.useSparse:: objects. This can have significant performance benefits when computing a pack to send a small change. However, it is possible that extra objects are added to the pack-file if the included - commits contain certain types of direct renames. Default is `false` - unless `feature.experimental` is enabled. + commits contain certain types of direct renames. pack.writeBitmaps (deprecated):: This is a deprecated synonym for `repack.writeBitmaps`. diff --git a/third_party/git/Documentation/config/protocol.txt b/third_party/git/Documentation/config/protocol.txt index 756591d77b08..bfccc074913e 100644 --- a/third_party/git/Documentation/config/protocol.txt +++ b/third_party/git/Documentation/config/protocol.txt @@ -45,10 +45,11 @@ The protocol names currently used by git are: -- protocol.version:: - If set, clients will attempt to communicate with a server - using the specified protocol version. If the server does - not support it, communication falls back to version 0. - If unset, the default is `2`. + 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: + -- diff --git a/third_party/git/Documentation/config/pull.txt b/third_party/git/Documentation/config/pull.txt index 540483060956..b87cab31b39c 100644 --- a/third_party/git/Documentation/config/pull.txt +++ b/third_party/git/Documentation/config/pull.txt @@ -14,16 +14,15 @@ pull.rebase:: pull" is run. See "branch.<name>.rebase" for setting this on a per-branch basis. + -When `merges` (or just 'm'), pass the `--rebase-merges` option to 'git rebase' +When `merges`, pass the `--rebase-merges` option to 'git rebase' so that the local merge commits are included in the rebase (see linkgit:git-rebase[1] for details). + -When `preserve` (or just 'p', deprecated in favor of `merges`), also pass +When `preserve` (deprecated in favor of `merges`), also pass `--preserve-merges` along to 'git rebase' so that locally committed merge commits will not be flattened by running 'git pull'. + -When the value is `interactive` (or just 'i'), the rebase is run in interactive -mode. +When the value is `interactive`, the rebase is run in interactive mode. + *NOTE*: this is a possibly dangerous operation; do *not* use it unless you understand the implications (see linkgit:git-rebase[1] diff --git a/third_party/git/Documentation/config/push.txt b/third_party/git/Documentation/config/push.txt index 0a7aa322a9be..0a0e000569d8 100644 --- a/third_party/git/Documentation/config/push.txt +++ b/third_party/git/Documentation/config/push.txt @@ -1,7 +1,6 @@ push.default:: Defines the action `git push` should take if no refspec is - given (whether from the command-line, config, or elsewhere). - Different values are well-suited for + explicitly given. Different values are well-suited for specific workflows; for instance, in a purely central workflow (i.e. the fetch source is equal to the push destination), `upstream` is probably what you want. Possible values are: @@ -9,7 +8,7 @@ push.default:: -- * `nothing` - do not push anything (error out) unless a refspec is - given. This is primarily meant for people who want to + explicitly given. This is primarily meant for people who want to avoid mistakes by always being explicit. * `current` - push the current branch to update a branch with the same @@ -80,7 +79,7 @@ higher priority configuration file (e.g. `.git/config` in a repository) to clear the values inherited from a lower priority configuration files (e.g. `$HOME/.gitconfig`). + ----- +-- Example: @@ -97,7 +96,7 @@ repo/.git/config This will result in only b (a and c are cleared). ----- +-- push.recurseSubmodules:: Make sure all submodule commits used by the revisions to be pushed diff --git a/third_party/git/Documentation/config/rebase.txt b/third_party/git/Documentation/config/rebase.txt index 7f7a07d22f86..d98e32d812e7 100644 --- a/third_party/git/Documentation/config/rebase.txt +++ b/third_party/git/Documentation/config/rebase.txt @@ -5,12 +5,6 @@ rebase.useBuiltin:: is always used. Setting this will emit a warning, to alert any remaining users that setting this now does nothing. -rebase.backend:: - Default backend to use for rebasing. Possible choices are - 'apply' or 'merge'. In the future, if the merge backend gains - all remaining capabilities of the apply backend, this setting - may become unused. - rebase.stat:: Whether to show a diffstat of what changed upstream since the last rebase. False by default. diff --git a/third_party/git/Documentation/config/remote.txt b/third_party/git/Documentation/config/remote.txt index a8e6437a9035..6c4cad83a2c9 100644 --- a/third_party/git/Documentation/config/remote.txt +++ b/third_party/git/Documentation/config/remote.txt @@ -76,11 +76,3 @@ remote.<name>.pruneTags:: + See also `remote.<name>.prune` and the PRUNING section of linkgit:git-fetch[1]. - -remote.<name>.promisor:: - When set to true, this remote will be used to fetch promisor - objects. - -remote.<name>.partialclonefilter:: - The filter that will be applied when fetching from this - promisor remote. diff --git a/third_party/git/Documentation/config/submodule.txt b/third_party/git/Documentation/config/submodule.txt index b33177151c5f..0a1293b05135 100644 --- a/third_party/git/Documentation/config/submodule.txt +++ b/third_party/git/Documentation/config/submodule.txt @@ -79,6 +79,4 @@ submodule.alternateLocation:: submodule.alternateErrorStrategy:: Specifies how to treat errors with the alternates for a submodule as computed via `submodule.alternateLocation`. Possible values are - `ignore`, `info`, `die`. Default is `die`. Note that if set to `ignore` - or `info`, and if there is an error with the computed alternate, the - clone proceeds as if no alternate was specified. + `ignore`, `info`, `die`. Default is `die`. diff --git a/third_party/git/Documentation/config/tag.txt b/third_party/git/Documentation/config/tag.txt index 6d9110d84ce7..ef5adb3f420d 100644 --- a/third_party/git/Documentation/config/tag.txt +++ b/third_party/git/Documentation/config/tag.txt @@ -13,7 +13,7 @@ tag.gpgSign:: Use of this option when running in an automated script can result in a large number of tags being signed. It is therefore convenient to use an agent to avoid typing your gpg passphrase - several times. Note that this option doesn't affect tag signing + several times. Note that this option doesn't affects tag signing behavior enabled by "-u <keyid>" or "--local-user=<keyid>" options. tar.umask:: diff --git a/third_party/git/Documentation/config/trace2.txt b/third_party/git/Documentation/config/trace2.txt index 4ce0b9a6d17f..2edbfb02fe5b 100644 --- a/third_party/git/Documentation/config/trace2.txt +++ b/third_party/git/Documentation/config/trace2.txt @@ -54,9 +54,3 @@ trace2.destinationDebug:: By default, these errors are suppressed and tracing is silently disabled. May be overridden by the `GIT_TRACE2_DST_DEBUG` environment variable. - -trace2.maxFiles:: - Integer. When writing trace files to a target directory, do not - write additional traces if we would exceed this many files. Instead, - write a sentinel file that will block further tracing to this - directory. Defaults to 0, which disables this check. diff --git a/third_party/git/Documentation/config/user.txt b/third_party/git/Documentation/config/user.txt index 59aec7c3aed3..0557cbbceb81 100644 --- a/third_party/git/Documentation/config/user.txt +++ b/third_party/git/Documentation/config/user.txt @@ -13,12 +13,7 @@ committer.email:: Also, all of these can be overridden by the `GIT_AUTHOR_NAME`, `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_NAME`, `GIT_COMMITTER_EMAIL` and `EMAIL` environment variables. -+ -Note that the `name` forms of these variables conventionally refer to -some form of a personal name. See linkgit:git-commit[1] and the -environment variables section of linkgit:git[1] for more information on -these settings and the `credential.username` option if you're looking -for authentication credentials instead. + See linkgit:git-commit-tree[1] for more information. user.useConfigOnly:: Instruct Git to avoid trying to guess defaults for `user.email` |