Merge branch 'as/docfix-reflog-expire-unreachable' into maint
authorJunio C Hamano <gitster@pobox.com>
Fri, 4 Sep 2015 02:17:53 +0000 (19:17 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 4 Sep 2015 02:17:53 +0000 (19:17 -0700)
Docfix.

* as/docfix-reflog-expire-unreachable:
  Documentation/config: fix inconsistent label on gc.*.reflogExpireUnreachable

1  2 
Documentation/config.txt

diff --combined Documentation/config.txt
@@@ -14,8 -14,7 +14,8 @@@ the fully qualified variable name of th
  dot-separated segment and the section name is everything before the last
  dot. The variable names are case-insensitive, allow only alphanumeric
  characters and `-`, and must start with an alphabetic character.  Some
 -variables may appear multiple times.
 +variables may appear multiple times; we say then that the variable is
 +multivalued.
  
  Syntax
  ~~~~~~
@@@ -26,7 -25,7 +26,7 @@@ blank lines are ignored
  
  The file consists of sections and variables.  A section begins with
  the name of the section in square brackets and continues until the next
 -section begins.  Section names are not case sensitive.  Only alphanumeric
 +section begins.  Section names are case-insensitive.  Only alphanumeric
  characters, `-` and `.` are allowed in section names.  Each variable
  must belong to some section, which means that there must be a section
  header before the first setting of a variable.
@@@ -41,8 -40,8 +41,8 @@@ in the section header, like in the exam
  --------
  
  Subsection names are case sensitive and can contain any characters except
 -newline (doublequote `"` and backslash have to be escaped as `\"` and `\\`,
 -respectively).  Section headers cannot span multiple
 +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.
@@@ -54,27 -53,38 +54,27 @@@ restrictions as section names
  
  All the other lines (and the remainder of the line after the section
  header) are recognized as setting variables, in the form
 -'name = value'.  If there is no equal sign on the line, the entire line
 -is taken as 'name' and the variable is recognized as boolean "true".
 +'name = value' (or just 'name', which is a short-hand to say that
 +the variable is the boolean "true").
  The variable names are case-insensitive, allow only alphanumeric characters
 -and `-`, and must start with an alphabetic character.  There can be more
 -than one value for a given variable; we say then that the variable is
 -multivalued.
 -
 -Leading and trailing whitespace in a variable value is discarded.
 -Internal whitespace within a variable value is retained verbatim.
 +and `-`, and must start with an alphabetic character.
  
 -The values following the equals sign in variable assign are all either
 -a string, an integer, or a boolean.  Boolean values may be given as yes/no,
 -1/0, true/false or on/off.  Case is not significant in boolean values, when
 -converting value to the canonical form using '--bool' type specifier;
 -'git config' will ensure that the output is "true" or "false".
 +A line that defines a value can be continued to the next line by
 +ending it with a `\`; the backquote and the end-of-line are
 +stripped.  Leading whitespaces after 'name =', the remainder of the
 +line after the first comment character '#' or ';', and trailing
 +whitespaces of the line are discarded unless they are enclosed in
 +double quotes.  Internal whitespaces within the value are retained
 +verbatim.
  
 -String values may be entirely or partially enclosed in double quotes.
 -You need to enclose variable values in double quotes if you want to
 -preserve leading or trailing whitespace, or if the variable value contains
 -comment characters (i.e. it contains '#' or ';').
 -Double quote `"` and backslash `\` characters in variable values must
 -be escaped: use `\"` for `"` and `\\` for `\`.
 +Inside double quotes, double quote `"` and backslash `\` characters
 +must be escaped: use `\"` for `"` and `\\` for `\`.
  
  The following escape sequences (beside `\"` and `\\`) are recognized:
  `\n` for newline character (NL), `\t` for horizontal tabulation (HT, TAB)
  and `\b` for backspace (BS).  Other char escape sequences (including octal
  escape sequences) are invalid.
  
 -Variable values ending in a `\` are continued on the next line in the
 -customary UNIX fashion.
 -
 -Some variables may require a special value format.
  
  Includes
  ~~~~~~~~
@@@ -116,60 -126,6 +116,60 @@@ Exampl
                path = foo ; expand "foo" relative to the current file
                path = ~/foo ; expand "foo" in your $HOME directory
  
 +
 +Values
 +~~~~~~
 +
 +Values of many variables are treated as a simple string, but there
 +are variables that take values of specific types and there are rules
 +as to how to spell them.
 +
 +boolean::
 +
 +       When a variable is said to take a boolean value, many
 +       synonyms are accepted for 'true' and 'false'; these are all
 +       case-insensitive.
 +
 +       true;; Boolean true can be spelled as `yes`, `on`, `true`,
 +              or `1`.  Also, a variable defined without `= <value>`
 +              is taken as true.
 +
 +       false;; Boolean false can be spelled as `no`, `off`,
 +              `false`, or `0`.
 ++
 +When converting value to the canonical form using '--bool' type
 +specifier; 'git config' will ensure that the output is "true" or
 +"false" (spelled in lowercase).
 +
 +integer::
 +       The value for many variables that specify various sizes can
 +       be suffixed with `k`, `M`,... to mean "scale the number by
 +       1024", "by 1024x1024", etc.
 +
 +color::
 +       The value for a variables that takes a color is a list of
 +       colors (at most two) and attributes (at most one), separated
 +       by spaces.  The colors accepted are `normal`, `black`,
 +       `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
 +       `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
 +       `reverse`.  The first color given is the foreground; the
 +       second is the background.  The position of the attribute, if
 +       any, doesn't matter. Attributes may be turned off specifically
 +       by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
 ++
 +Colors (foreground and background) may also be given as numbers between
 +0 and 255; these use ANSI 256-color mode (but note that not all
 +terminals may support this).  If your terminal supports it, you may also
 +specify 24-bit RGB values as hex, like `#ff0ab3`.
 ++
 +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 plain `black`, even if the previous
 +thing on the same output line (e.g. opening parenthesis before the
 +list of branch names in `log --decorate` output) is set to be
 +painted with `bold` or some other attribute.
 +
 +
  Variables
  ~~~~~~~~~
  
@@@ -453,8 -409,6 +453,8 @@@ false), while all other repositories ar
  
  core.worktree::
        Set the path to the root of the working tree.
 +      If GIT_COMMON_DIR environment variable is set, core.worktree
 +      is ignored and not used for determining the root of working tree.
        This can be overridden by the GIT_WORK_TREE environment
        variable and the '--work-tree' command-line option.
        The value can be an absolute path or relative to the path to
@@@ -624,12 -578,6 +624,12 @@@ core.commentChar:
  If set to "auto", `git-commit` would select a character that is not
  the beginning character of any line in existing commit messages.
  
 +core.packedRefsTimeout::
 +      The length of time, in milliseconds, to retry when trying to
 +      lock the `packed-refs` file. Value 0 means not to retry at
 +      all; -1 means to try indefinitely. Default is 1000 (i.e.,
 +      retry for 1 second).
 +
  sequence.editor::
        Text editor used by `git rebase -i` for editing the rebase instruction file.
        The value is meant to be interpreted by the shell when it is used.
@@@ -898,6 -846,20 +898,6 @@@ color.branch.<slot>:
        `remote` (a remote-tracking branch in refs/remotes/),
        `upstream` (upstream tracking branch), `plain` (other
        refs).
 -+
 -The value for these configuration variables is a list of colors (at most
 -two) and attributes (at most one), separated by spaces.  The colors
 -accepted are `normal`, `black`, `red`, `green`, `yellow`, `blue`,
 -`magenta`, `cyan` and `white`; the attributes are `bold`, `dim`, `ul`,
 -`blink` and `reverse`.  The first color given is the foreground; the
 -second is the background.  The position of the attribute, if any,
 -doesn't matter. Attributes may be turned off specifically by prefixing
 -them with `no` (e.g., `noreverse`, `noul`, etc).
 -+
 -Colors (foreground and background) may also be given as numbers between
 -0 and 255; these use ANSI 256-color mode (but note that not all
 -terminals may support this).  If your terminal supports it, you may also
 -specify 24-bit RGB values as hex, like `#ff0ab3`.
  
  color.diff::
        Whether to use ANSI escape sequences to add color to patches.
@@@ -914,11 -876,11 +914,11 @@@ command line with the `--color[=<when>]
  color.diff.<slot>::
        Use customized color for diff colorization.  `<slot>` specifies
        which part of the patch to use the specified color, and is one
 -      of `plain` (context text), `meta` (metainformation), `frag`
 +      of `context` (context text - `plain` is a historical synonym),
 +      `meta` (metainformation), `frag`
        (hunk header), 'func' (function in hunk header), `old` (removed lines),
        `new` (added lines), `commit` (commit headers), or `whitespace`
 -      (highlighting whitespace errors). The values of these variables may be
 -      specified as in color.branch.<slot>.
 +      (highlighting whitespace errors).
  
  color.decorate.<slot>::
        Use customized color for 'git log --decorate' output.  `<slot>` is one
@@@ -955,6 -917,8 +955,6 @@@ color.grep.<slot>:
        separators between fields on a line (`:`, `-`, and `=`)
        and between hunks (`--`)
  --
 -+
 -The values of these variables may be specified as in color.branch.<slot>.
  
  color.interactive::
        When set to `always`, always use colors for interactive prompts
@@@ -967,7 -931,8 +967,7 @@@ color.interactive.<slot>:
        Use customized color for 'git add --interactive' and 'git clean
        --interactive' output. `<slot>` may be `prompt`, `header`, `help`
        or `error`, for four distinct types of normal output from
 -      interactive commands.  The values of these variables may be
 -      specified as in color.branch.<slot>.
 +      interactive commands.
  
  color.pager::
        A boolean to enable/disable colored output when the pager is in
@@@ -991,10 -956,10 +991,10 @@@ color.status.<slot>:
        `added` or `updated` (files which are added but not committed),
        `changed` (files which are changed but not added in the index),
        `untracked` (files which are not tracked by Git),
 -      `branch` (the current branch), or
 +      `branch` (the current branch),
        `nobranch` (the color the 'no branch' warning is shown in, defaulting
 -      to red). The values of these variables may be specified as in
 -      color.branch.<slot>.
 +      to red), or
 +      `unmerged` (files which have unmerged changes).
  
  color.ui::
        This variable determines the default value for variables such
@@@ -1283,13 -1248,6 +1283,13 @@@ gc.pruneExpire:
        "now" may be used to disable this  grace period and always prune
        unreachable objects immediately.
  
 +gc.pruneWorktreesExpire::
 +      When 'git gc' is run, it will call
 +      'prune --worktrees --expire 3.months.ago'.
 +      Override the grace period with this config variable. The value
 +      "now" may be used to disable the grace period and prune
 +      $GIT_DIR/worktrees immediately.
 +
  gc.reflogExpire::
  gc.<pattern>.reflogExpire::
        'git reflog expire' removes reflog entries older than
        the refs that match the <pattern>.
  
  gc.reflogExpireUnreachable::
- gc.<ref>.reflogExpireUnreachable::
+ gc.<pattern>.reflogExpireUnreachable::
        'git reflog expire' removes reflog entries older than
        this time and are not reachable from the current tip;
        defaults to 30 days.  With "<pattern>" (e.g. "refs/stash")
@@@ -1576,19 -1534,6 +1576,19 @@@ http.saveCookies:
        If set, store cookies received during requests to the file specified by
        http.cookieFile. Has no effect if http.cookieFile is unset.
  
 +http.sslCipherList::
 +  A list of SSL ciphers to use when negotiating an SSL connection.
 +  The available ciphers depend on whether libcurl was built against
 +  NSS or OpenSSL and the particular configuration of the crypto
 +  library in use.  Internally this sets the 'CURLOPT_SSL_CIPHER_LIST'
 +  option; see the libcurl documentation for more details on the format
 +  of this list.
 ++
 +Can be overridden by the 'GIT_SSL_CIPHER_LIST' environment variable.
 +To force git to use libcurl's default cipher list and ignore any
 +explicit http.sslCipherList option, set 'GIT_SSL_CIPHER_LIST' to the
 +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
@@@ -2062,7 -2007,7 +2062,7 @@@ pull.ff:
        a case (equivalent to giving the `--no-ff` option from the command
        line). When set to `only`, only such fast-forward merges are
        allowed (equivalent to giving the `--ff-only` option from the
 -      command line).
 +      command line). This setting overrides `merge.ff` when pulling.
  
  pull.rebase::
        When true, rebase branches on top of the fetched branch, instead
@@@ -2140,12 -2085,6 +2140,12 @@@ new default)
  
  --
  
 +push.followTags::
 +      If set to true enable '--follow-tags' option by default.  You
 +      may override this configuration at time of push by specifying
 +      '--no-follow-tags'.
 +
 +
  rebase.stat::
        Whether to show a diffstat of what changed upstream since the last
        rebase. False by default.
@@@ -2299,18 -2238,18 +2299,18 @@@ remote.<name>.skipFetchAll:
  
  remote.<name>.receivepack::
        The default program to execute on the remote side when pushing.  See
 -      option \--receive-pack of linkgit:git-push[1].
 +      option --receive-pack of linkgit:git-push[1].
  
  remote.<name>.uploadpack::
        The default program to execute on the remote side when fetching.  See
 -      option \--upload-pack of linkgit:git-fetch-pack[1].
 +      option --upload-pack of linkgit:git-fetch-pack[1].
  
  remote.<name>.tagOpt::
 -      Setting this value to \--no-tags disables automatic tag following when
 -      fetching from remote <name>. Setting it to \--tags will fetch every
 +      Setting this value to --no-tags disables automatic tag following when
 +      fetching from remote <name>. Setting it to --tags will fetch every
        tag from remote <name>, even if they are not reachable from remote
        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
 -      override this setting. See options \--tags and \--no-tags of
 +      override this setting. See options --tags and --no-tags of
        linkgit:git-fetch[1].
  
  remote.<name>.vcs::
@@@ -2559,20 -2498,14 +2559,20 @@@ uploadpack.hideRefs:
        are under the hierarchies listed on the value of this
        variable is excluded, and is hidden from `git ls-remote`,
        `git fetch`, etc.  An attempt to fetch a hidden ref by `git
 -      fetch` will fail.  See also `uploadpack.allowtipsha1inwant`.
 +      fetch` will fail.  See also `uploadpack.allowTipSHA1InWant`.
  
 -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`.
  
 +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`.
 +
  uploadpack.keepAlive::
        When `upload-pack` has started `pack-objects`, there may be a
        quiet period while `pack-objects` prepares the pack. Normally
@@@ -2625,18 -2558,6 +2625,18 @@@ 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.
 +
  web.browser::
        Specify a web browser that may be used by some commands.
        Currently only linkgit:git-instaweb[1] and linkgit:git-help[1]