config.txt: move user.* to a separate file
[gitweb.git] / Documentation / config.txt
index 07100e236e4d402717821b2ed92adc1bd1dd07cd..3cba2420e0a344c622537fcc1df275e1646d313a 100644 (file)
@@ -423,136 +423,13 @@ include::config/tag.txt[]
 
 include::config/transfer.txt[]
 
-uploadarchive.allowUnreachable::
-       If true, allow clients to use `git archive --remote` to request
-       any tree, whether reachable from the ref tips or not. See the
-       discussion in the "SECURITY" section of
-       linkgit:git-upload-archive[1] for more details. Defaults to
-       `false`.
-
-uploadpack.hideRefs::
-       This variable is the same as `transfer.hideRefs`, but applies
-       only to `upload-pack` (and so affects only fetches, not pushes).
-       An attempt to fetch a hidden ref by `git fetch` will fail.  See
-       also `uploadpack.allowTipSHA1InWant`.
-
-uploadpack.allowTipSHA1InWant::
-       When `uploadpack.hideRefs` is in effect, allow `upload-pack`
-       to accept a fetch request that asks for an object at the tip
-       of a hidden ref (by default, such a request is rejected).
-       See also `uploadpack.hideRefs`.  Even if this is false, a client
-       may be able to steal objects via the techniques described in the
-       "SECURITY" section of the linkgit:gitnamespaces[7] man page; it's
-       best to keep private data in a separate repository.
-
-uploadpack.allowReachableSHA1InWant::
-       Allow `upload-pack` to accept a fetch request that asks for an
-       object that is reachable from any ref tip. However, note that
-       calculating object reachability is computationally expensive.
-       Defaults to `false`.  Even if this is false, a client may be able
-       to steal objects via the techniques described in the "SECURITY"
-       section of the linkgit:gitnamespaces[7] man page; it's best to
-       keep private data in a separate repository.
-
-uploadpack.allowAnySHA1InWant::
-       Allow `upload-pack` to accept a fetch request that asks for any
-       object at all.
-       Defaults to `false`.
-
-uploadpack.keepAlive::
-       When `upload-pack` has started `pack-objects`, there may be a
-       quiet period while `pack-objects` prepares the pack. Normally
-       it would output progress information, but if `--quiet` was used
-       for the fetch, `pack-objects` will output nothing at all until
-       the pack data begins. Some clients and networks may consider
-       the server to be hung and give up. Setting this option instructs
-       `upload-pack` to send an empty keepalive packet every
-       `uploadpack.keepAlive` seconds. Setting this option to 0
-       disables keepalive packets entirely. The default is 5 seconds.
-
-uploadpack.packObjectsHook::
-       If this option is set, when `upload-pack` would run
-       `git pack-objects` to create a packfile for a client, it will
-       run this shell command instead.  The `pack-objects` command and
-       arguments it _would_ have run (including the `git pack-objects`
-       at the beginning) are appended to the shell command. The stdin
-       and stdout of the hook are treated as if `pack-objects` itself
-       was run. I.e., `upload-pack` will feed input intended for
-       `pack-objects` to the hook, and expects a completed packfile on
-       stdout.
-+
-Note that this configuration variable is ignored if it is seen in the
-repository-level config (this is a safety measure against fetching from
-untrusted repositories).
-
-uploadpack.allowFilter::
-       If this option is set, `upload-pack` will support partial
-       clone and partial fetch object filtering.
-
-uploadpack.allowRefInWant::
-       If this option is set, `upload-pack` will support the `ref-in-want`
-       feature of the protocol version 2 `fetch` command.  This feature
-       is intended for the benefit of load-balanced servers which may
-       not have the same view of what OIDs their refs point to due to
-       replication delay.
-
-url.<base>.insteadOf::
-       Any URL that starts with this value will be rewritten to
-       start, instead, with <base>. In cases where some site serves a
-       large number of repositories, and serves them with multiple
-       access methods, and some users need to use different access
-       methods, this feature allows people to specify any of the
-       equivalent URLs and have Git automatically rewrite the URL to
-       the best alternative for the particular user, even for a
-       never-before-seen repository on the site.  When more than one
-       insteadOf strings match a given URL, the longest match is used.
-+
-Note that any protocol restrictions will be applied to the rewritten
-URL. If the rewrite changes the URL to use a custom protocol or remote
-helper, you may need to adjust the `protocol.*.allow` config to permit
-the request.  In particular, protocols you expect to use for submodules
-must be set to `always` rather than the default of `user`. See the
-description of `protocol.allow` above.
-
-url.<base>.pushInsteadOf::
-       Any URL that starts with this value will not be pushed to;
-       instead, it will be rewritten to start with <base>, and the
-       resulting URL will be pushed to. In cases where some site serves
-       a large number of repositories, and serves them with multiple
-       access methods, some of which do not allow push, this feature
-       allows people to specify a pull-only URL and have Git
-       automatically use an appropriate URL to push, even for a
-       never-before-seen repository on the site.  When more than one
-       pushInsteadOf strings match a given URL, the longest match is
-       used.  If a remote has an explicit pushurl, Git will ignore this
-       setting for that remote.
-
-user.email::
-       Your email address to be recorded in any newly created commits.
-       Can be overridden by the `GIT_AUTHOR_EMAIL`, `GIT_COMMITTER_EMAIL`, and
-       `EMAIL` environment variables.  See linkgit:git-commit-tree[1].
-
-user.name::
-       Your full name to be recorded in any newly created commits.
-       Can be overridden by the `GIT_AUTHOR_NAME` and `GIT_COMMITTER_NAME`
-       environment variables.  See linkgit:git-commit-tree[1].
-
-user.useConfigOnly::
-       Instruct Git to avoid trying to guess defaults for `user.email`
-       and `user.name`, and instead retrieve the values only from the
-       configuration. For example, if you have multiple email addresses
-       and would like to use a different one for each repository, then
-       with this configuration option set to `true` in the global config
-       along with a name, Git will prompt you to set up an email before
-       making new commits in a newly cloned repository.
-       Defaults to `false`.
-
-user.signingKey::
-       If linkgit:git-tag[1] or linkgit:git-commit[1] is not selecting the
-       key you want it to automatically when creating a signed tag or
-       commit, you can override the default selection with this variable.
-       This option is passed unchanged to gpg's --local-user parameter,
-       so you may specify a key using any method that gpg supports.
+include::config/uploadarchive.txt[]
+
+include::config/uploadpack.txt[]
+
+include::config/url.txt[]
+
+include::config/user.txt[]
 
 versionsort.prereleaseSuffix (deprecated)::
        Deprecated alias for `versionsort.suffix`.  Ignored if