Merge branch 'dp/submodule-doc-markup-fix'
authorJunio C Hamano <gitster@pobox.com>
Thu, 16 Feb 2017 22:45:15 +0000 (14:45 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 16 Feb 2017 22:45:15 +0000 (14:45 -0800)
Doc fix.

* dp/submodule-doc-markup-fix:
config.txt: fix formatting of submodule.alternateErrorStrategy section

1  2 
Documentation/config.txt
diff --combined Documentation/config.txt
index fc5a28a3204b5c3d23cbce43679d5b04f3ff957b,e329292aaf969bebe8682f0142d005a23fc4af04..015346c4173c5f29b33445280ae849f3fcfffaa3
@@@ -170,9 -170,6 +170,9 @@@ The position of any attributes with res
  be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
  `no-ul`, etc).
  +
 +An empty color string produces no color effect at all. This can be used
 +to avoid coloring specific elements without disabling color entirely.
 ++
  For git's pre-defined color slots, the attributes are meant to be reset
  at the beginning of each item in the colored output. So setting
  `color.decorate.branch` to `black` will paint that branch name in a
@@@ -520,12 -517,10 +520,12 @@@ core.logAllRefUpdates:
        "`$GIT_DIR/logs/<ref>`", by appending the new and old
        SHA-1, the date/time and the reason of the update, but
        only when the file exists.  If this configuration
 -      variable is set to true, missing "`$GIT_DIR/logs/<ref>`"
 +      variable is set to `true`, missing "`$GIT_DIR/logs/<ref>`"
        file is automatically created for branch heads (i.e. under
 -      refs/heads/), remote refs (i.e. under refs/remotes/),
 -      note refs (i.e. under refs/notes/), and the symbolic ref HEAD.
 +      `refs/heads/`), remote refs (i.e. under `refs/remotes/`),
 +      note refs (i.e. under `refs/notes/`), and the symbolic ref `HEAD`.
 +      If it is set to `always`, then a missing reflog is automatically
 +      created for any ref under `refs/`.
  +
  This information can be used to determine what commit
  was the tip of a branch "2 days ago".
@@@ -788,11 -783,10 +788,11 @@@ core.sparseCheckout:
        linkgit:git-read-tree[1] for more information.
  
  core.abbrev::
 -      Set the length object names are abbreviated to.  If unspecified,
 -      many commands abbreviate to 7 hexdigits, which may not be enough
 -      for abbreviated object names to stay unique for sufficiently long
 -      time.
 +      Set the length object names are abbreviated to.  If
 +      unspecified or set to "auto", an appropriate value is
 +      computed based on the approximate number of packed objects
 +      in your repository, which hopefully is enough for
 +      abbreviated object names to stay unique for some time.
  
  add.ignoreErrors::
  add.ignore-errors (deprecated)::
@@@ -959,8 -953,7 +959,8 @@@ color.branch:
        A boolean to enable/disable color in the output of
        linkgit:git-branch[1]. May be set to `always`,
        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 -      only when the output is to a terminal. Defaults to false.
 +      only when the output is to a terminal. If unset, then the
 +      value of `color.ui` is used (`auto` by default).
  
  color.branch.<slot>::
        Use customized color for branch coloration. `<slot>` is one of
@@@ -975,8 -968,7 +975,8 @@@ color.diff:
        linkgit:git-log[1], and linkgit:git-show[1] will use color
        for all patches.  If it is set to `true` or `auto`, those
        commands will only use color when output is to the terminal.
 -      Defaults to false.
 +      If unset, then the value of `color.ui` is used (`auto` by
 +      default).
  +
  This does not affect linkgit:git-format-patch[1] or the
  'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
@@@ -999,8 -991,7 +999,8 @@@ color.decorate.<slot>:
  color.grep::
        When set to `always`, always highlight matches.  When `false` (or
        `never`), never.  When set to `true` or `auto`, use color only
 -      when the output is written to the terminal.  Defaults to `false`.
 +      when the output is written to the terminal.  If unset, then the
 +      value of `color.ui` is used (`auto` by default).
  
  color.grep.<slot>::
        Use customized color for grep colorization.  `<slot>` specifies which
@@@ -1033,8 -1024,7 +1033,8 @@@ color.interactive:
        and displays (such as those used by "git-add --interactive" and
        "git-clean --interactive"). When false (or `never`), never.
        When set to `true` or `auto`, use colors only when the output is
 -      to the terminal. Defaults to false.
 +      to the terminal. If unset, then the value of `color.ui` is
 +      used (`auto` by default).
  
  color.interactive.<slot>::
        Use customized color for 'git add --interactive' and 'git clean
@@@ -1050,15 -1040,13 +1050,15 @@@ color.showBranch:
        A boolean to enable/disable color in the output of
        linkgit:git-show-branch[1]. May be set to `always`,
        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 -      only when the output is to a terminal. Defaults to false.
 +      only when the output is to a terminal. If unset, then the
 +      value of `color.ui` is used (`auto` by default).
  
  color.status::
        A boolean to enable/disable color in the output of
        linkgit:git-status[1]. May be set to `always`,
        `false` (or `never`) or `auto` (or `true`), in which case colors are used
 -      only when the output is to a terminal. Defaults to false.
 +      only when the output is to a terminal. If unset, then the
 +      value of `color.ui` is used (`auto` by default).
  
  color.status.<slot>::
        Use customized color for status colorization. `<slot>` is
@@@ -1265,16 -1253,6 +1265,16 @@@ format.attach:
        value as the boundary.  See the --attach option in
        linkgit:git-format-patch[1].
  
 +format.from::
 +      Provides the default value for the `--from` option to format-patch.
 +      Accepts a boolean value, or a name and email address.  If false,
 +      format-patch defaults to `--no-from`, using commit authors directly in
 +      the "From:" field of patch mails.  If true, format-patch defaults to
 +      `--from`, using your committer identity in the "From:" field of patch
 +      mails and including a "From:" field in the body of the patch mail if
 +      different.  If set to a non-boolean value, format-patch uses that
 +      value instead of your committer identity.  Defaults to false.
 +
  format.numbered::
        A boolean which can enable or disable sequence numbers in patch
        subjects.  It defaults to "auto" which enables it only if there
@@@ -1378,7 -1356,7 +1378,7 @@@ fsck.skipList:
  gc.aggressiveDepth::
        The depth parameter used in the delta compression
        algorithm used by 'git gc --aggressive'.  This defaults
 -      to 250.
 +      to 50.
  
  gc.aggressiveWindow::
        The window size parameter used in the delta compression
@@@ -1415,9 -1393,7 +1415,9 @@@ gc.pruneExpire:
        Override the grace period with this config variable.  The value
        "now" may be used to disable this grace period and always prune
        unreachable objects immediately, or "never" may be used to
 -      suppress pruning.
 +      suppress pruning.  This feature helps prevent corruption when
 +      'git gc' runs concurrently with another process writing to the
 +      repository; see the "NOTES" section of linkgit:git-gc[1].
  
  gc.worktreePruneExpire::
        When 'git gc' is run, it calls
@@@ -1744,20 -1720,6 +1744,20 @@@ http.emptyAuth:
        a username in the URL, as libcurl normally requires a username for
        authentication.
  
 +http.delegation::
 +      Control GSSAPI credential delegation. The delegation is disabled
 +      by default in libcurl since version 7.21.7. Set parameter to tell
 +      the server what it is allowed to delegate when it comes to user
 +      credentials. Used with GSS/kerberos. Possible values are:
 ++
 +--
 +* `none` - Don't allow any delegation.
 +* `policy` - Delegates if and only if the OK-AS-DELEGATE flag is set in the
 +  Kerberos service ticket, which is a matter of realm policy.
 +* `always` - Unconditionally allow the server to delegate.
 +--
 +
 +
  http.extraHeader::
        Pass an additional HTTP header when communicating with a server.  If
        more than one such entry exists, all of them are added as extra
@@@ -1899,16 -1861,6 +1899,16 @@@ http.userAgent:
        of common USER_AGENT strings (but not including those like git/1.7.1).
        Can be overridden by the `GIT_HTTP_USER_AGENT` environment variable.
  
 +http.followRedirects::
 +      Whether git should follow HTTP redirects. If set to `true`, git
 +      will transparently follow any redirect issued by a server it
 +      encounters. If set to `false`, git will treat all redirects as
 +      errors. If set to `initial`, git will follow redirects only for
 +      the initial request to a remote, but not for subsequent
 +      follow-up HTTP requests. Since git uses the redirected URL as
 +      the base for the follow-up requests, this is generally
 +      sufficient. The default is `initial`.
 +
  http.<url>.*::
        Any of the http.* options above can be applied selectively to some URLs.
        For a config key to match a URL, each element of the config key is
@@@ -2041,10 -1993,6 +2041,10 @@@ log.follow:
        i.e. it cannot be used to follow multiple files and does not work well
        on non-linear history.
  
 +log.graphColors::
 +      A list of colors, separated by commas, that can be used to draw
 +      history lines in `git log --graph`.
 +
  log.showRoot::
        If true, the initial commit will be shown as a big creation event.
        This is equivalent to a diff against an empty tree.
@@@ -2330,52 -2278,6 +2330,52 @@@ pretty.<name>:
        Note that an alias with the same name as a built-in format
        will be silently ignored.
  
 +protocol.allow::
 +      If set, provide a user defined default policy for all protocols which
 +      don't explicitly have a policy (`protocol.<name>.allow`).  By default,
 +      if unset, known-safe protocols (http, https, git, ssh, file) have a
 +      default policy of `always`, known-dangerous protocols (ext) have a
 +      default policy of `never`, and all other protocols have a default
 +      policy of `user`.  Supported policies:
 ++
 +--
 +
 +* `always` - protocol is always able to be used.
 +
 +* `never` - protocol is never able to be used.
 +
 +* `user` - protocol is only able to be used when `GIT_PROTOCOL_FROM_USER` is
 +  either unset or has a value of 1.  This policy should be used when you want a
 +  protocol to be directly usable by the user but don't want it used by commands which
 +  execute clone/fetch/push commands without user input, e.g. recursive
 +  submodule initialization.
 +
 +--
 +
 +protocol.<name>.allow::
 +      Set a policy to be used by protocol `<name>` with clone/fetch/push
 +      commands. See `protocol.allow` above for the available policies.
 ++
 +The protocol names currently used by git are:
 ++
 +--
 +  - `file`: any local file-based path (including `file://` URLs,
 +    or local paths)
 +
 +  - `git`: the anonymous git protocol over a direct TCP
 +    connection (or proxy, if configured)
 +
 +  - `ssh`: git over ssh (including `host:path` syntax,
 +    `ssh://`, etc).
 +
 +  - `http`: git over http, both "smart http" and "dumb http".
 +    Note that this does _not_ include `https`; if you want to configure
 +    both, you must do so individually.
 +
 +  - any external helpers are named by their protocol (e.g., use
 +    `hg` to allow the `git-remote-hg` helper)
 +--
 +
  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
@@@ -2518,7 -2420,7 +2518,7 @@@ rebase.missingCommitsCheck:
        command in the todo-list.
        Defaults to "ignore".
  
 -rebase.instructionFormat
 +rebase.instructionFormat::
        A format string, as specified in linkgit:git-log[1], to be used for
        the instruction list during an interactive rebase.  The format will automatically
        have the long commit hash prepended to the format.
@@@ -2605,12 -2507,6 +2605,12 @@@ receive.unpackLimit:
        especially on slow filesystems.  If not set, the value of
        `transfer.unpackLimit` is used instead.
  
 +receive.maxInputSize::
 +      If the size of the incoming pack stream is larger than this
 +      limit, then git-receive-pack will error out, instead of
 +      accepting the pack file. If not set or set to 0, then the size
 +      is unlimited.
 +
  receive.denyDeletes::
        If set to true, git-receive-pack will deny a ref update that deletes
        the ref. Use this to prevent such a ref deletion via a push.
@@@ -2893,13 -2789,12 +2893,13 @@@ stash.showStat:
        option will show diffstat of the stash.  Defaults to true.
        See description of 'show' command in linkgit:git-stash[1].
  
 -submodule.<name>.path::
  submodule.<name>.url::
 -      The path within this project and URL for a submodule. These
 -      variables are initially populated by 'git submodule init'. See
 -      linkgit:git-submodule[1] and linkgit:gitmodules[5] for
 -      details.
 +      The URL for a submodule. This variable is copied from the .gitmodules
 +      file to the git config via 'git submodule init'. The user can change
 +      the configured URL before obtaining the submodule via 'git submodule
 +      update'. After obtaining the submodule, the presence of this variable
 +      is used as a sign whether the submodule is of interest to git commands.
 +      See linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
  
  submodule.<name>.update::
        The default update procedure for a submodule. This variable
@@@ -2949,7 -2844,7 +2949,7 @@@ submodule.alternateLocation:
        value is set to `superproject` the submodule to be cloned computes
        its alternates location relative to the superprojects alternate.
  
- submodule.alternateErrorStrategy
+ 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`.
@@@ -2998,11 -2893,6 +2998,11 @@@ is omitted from the advertisements but 
  `refs/namespaces/bar/refs/heads/master` are still advertised as so-called
  "have" lines. In order to match refs before stripping, add a `^` in front of
  the ref name. If you combine `!` and `^`, `!` must be specified first.
 ++
 +Even if you hide refs, a client may still be able to steal the target
 +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.
  
  transfer.unpackLimit::
        When `fetch.unpackLimit` or `receive.unpackLimit` are
  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
 +      discussion in the "SECURITY" section of
        linkgit:git-upload-archive[1] for more details. Defaults to
        `false`.
  
@@@ -3026,23 -2916,12 +3026,23 @@@ 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`.
 +      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::
@@@ -3122,39 -3001,17 +3122,39 @@@ user.signingKey:
        This option is passed unchanged to gpg's --local-user parameter,
        so you may specify a key using any method that gpg supports.
  
 -versionsort.prereleaseSuffix::
 -      When version sort is used in linkgit:git-tag[1], prerelease
 -      tags (e.g. "1.0-rc1") may appear after the main release
 -      "1.0". By specifying the suffix "-rc" in this variable,
 -      "1.0-rc1" will appear before "1.0".
 -+
 -This variable can be specified multiple times, once per suffix. The
 -order of suffixes in the config file determines the sorting order
 -(e.g. if "-pre" appears before "-rc" in the config file then 1.0-preXX
 -is sorted before 1.0-rcXX). The sorting order between different
 -suffixes is undefined if they are in multiple config files.
 +versionsort.prereleaseSuffix (deprecated)::
 +      Deprecated alias for `versionsort.suffix`.  Ignored if
 +      `versionsort.suffix` is set.
 +
 +versionsort.suffix::
 +      Even when version sort is used in linkgit:git-tag[1], tagnames
 +      with the same base version but different suffixes are still sorted
 +      lexicographically, resulting e.g. in prerelease tags appearing
 +      after the main release (e.g. "1.0-rc1" after "1.0").  This
 +      variable can be specified to determine the sorting order of tags
 +      with different suffixes.
 ++
 +By specifying a single suffix in this variable, any tagname containing
 +that suffix will appear before the corresponding main release.  E.g. if
 +the variable is set to "-rc", then all "1.0-rcX" tags will appear before
 +"1.0".  If specified multiple times, once per suffix, then the order of
 +suffixes in the configuration will determine the sorting order of tagnames
 +with those suffixes.  E.g. if "-pre" appears before "-rc" in the
 +configuration, then all "1.0-preX" tags will be listed before any
 +"1.0-rcX" tags.  The placement of the main release tag relative to tags
 +with various suffixes can be determined by specifying the empty suffix
 +among those other suffixes.  E.g. if the suffixes "-rc", "", "-ck" and
 +"-bfs" appear in the configuration in this order, then all "v4.8-rcX" tags
 +are listed first, followed by "v4.8", then "v4.8-ckX" and finally
 +"v4.8-bfsX".
 ++
 +If more than one suffixes match the same tagname, then that tagname will
 +be sorted according to the suffix which starts at the earliest position in
 +the tagname.  If more than one different matching suffixes start at
 +that earliest position, then that tagname will be sorted according to the
 +longest of those suffixes.
 +The sorting order between different suffixes is undefined if they are
 +in multiple config files.
  
  web.browser::
        Specify a web browser that may be used by some commands.