Merge branch 'ss/help-htmlpath-config-doc'
authorJunio C Hamano <gitster@pobox.com>
Fri, 18 Jan 2013 19:20:20 +0000 (11:20 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 18 Jan 2013 19:20:20 +0000 (11:20 -0800)
Add missing doc.

* ss/help-htmlpath-config-doc:
config.txt: Document help.htmlpath config parameter

1  2 
Documentation/config.txt
diff --combined Documentation/config.txt
index d5809e0e8c4dca414a863cfd019a6f8860c46c4d,351a1fbaaaa9d79eda7e51046b16e31b956926b6..ef45c99e53ed0b835b70f52346c2937379011918
@@@ -140,11 -140,10 +140,11 @@@ advice.*:
        can tell Git that you do not need help by setting these to 'false':
  +
  --
 -      pushNonFastForward::
 +      pushUpdateRejected::
                Set this variable to 'false' if you want to disable
 -              'pushNonFFCurrent', 'pushNonFFDefault', and
 -              'pushNonFFMatching' simultaneously.
 +              'pushNonFFCurrent', 'pushNonFFDefault',
 +              'pushNonFFMatching', and 'pushAlreadyExists'
 +              simultaneously.
        pushNonFFCurrent::
                Advice shown when linkgit:git-push[1] fails due to a
                non-fast-forward update to the current branch.
                'matching refs' explicitly (i.e. you used ':', or
                specified a refspec that isn't your current branch) and
                it resulted in a non-fast-forward error.
 +      pushAlreadyExists::
 +              Shown when linkgit:git-push[1] rejects an update that
 +              does not qualify for fast-forwarding (e.g., a tag.)
        statusHints::
                Show directions on how to proceed from the current
 -              state in the output of linkgit:git-status[1] and in
 +              state in the output of linkgit:git-status[1], in
                the template shown when writing commit messages in
 -              linkgit:git-commit[1].
 +              linkgit:git-commit[1], and in the help message shown
 +              by linkgit:git-checkout[1] when switching branch.
        commitBeforeMerge::
                Advice shown when linkgit:git-merge[1] refuses to
                merge to avoid overwriting local changes.
@@@ -543,14 -538,14 +543,14 @@@ core.pager:
        `LESS` variable to some other value.  Alternately,
        these settings can be overridden on a project or
        global basis by setting the `core.pager` option.
 -      Setting `core.pager` has no affect on the `LESS`
 +      Setting `core.pager` has no effect on the `LESS`
        environment variable behaviour above, so if you want
        to override git's default settings this way, you need
        to be explicit.  For example, to disable the S option
        in a backward compatible manner, set `core.pager`
 -      to `less -+$LESS -FRX`.  This will be passed to the
 -      shell by git, which will translate the final command to
 -      `LESS=FRSX less -+FRSX -FRX`.
 +      to `less -+S`.  This will be passed to the shell by
 +      git, which will translate the final command to
 +      `LESS=FRSX less -+S`.
  
  core.whitespace::
        A comma separated list of common whitespace problems to
@@@ -739,12 -734,6 +739,12 @@@ branch.<name>.rebase:
  it unless you understand the implications (see linkgit:git-rebase[1]
  for details).
  
 +branch.<name>.description::
 +      Branch description, can be edited with
 +      `git branch --edit-description`. Branch description is
 +      automatically added in the format-patch cover letter or
 +      request-pull summary.
 +
  browser.<tool>.cmd::
        Specify the command to invoke the specified browser. The
        specified command is evaluated in shell with the URLs passed
@@@ -973,6 -962,12 +973,6 @@@ difftool.<tool>.cmd:
  difftool.prompt::
        Prompt before each invocation of the diff tool.
  
 -diff.wordRegex::
 -      A POSIX Extended Regular Expression used to determine what is a "word"
 -      when performing word-by-word difference calculations.  Character
 -      sequences that match the regular expression are "words", all other
 -      characters are *ignorable* whitespace.
 -
  fetch.recurseSubmodules::
        This option can be either set to a boolean value or to 'on-demand'.
        Setting it to a boolean changes the behavior of fetch and pull to
@@@ -1216,16 -1211,8 +1216,16 @@@ gitweb.snapshot:
  grep.lineNumber::
        If set to true, enable '-n' option by default.
  
 +grep.patternType::
 +      Set the default matching behavior. Using a value of 'basic', 'extended',
 +      'fixed', or 'perl' will enable the '--basic-regexp', '--extended-regexp',
 +      '--fixed-strings', or '--perl-regexp' option accordingly, while the
 +      value 'default' will return to the default matching behavior.
 +
  grep.extendedRegexp::
 -      If set to true, enable '--extended-regexp' option by default.
 +      If set to true, enable '--extended-regexp' option by default. This
 +      option is ignored when the 'grep.patternType' option is set to a value
 +      other than 'default'.
  
  gpg.program::
        Use this custom program instead of "gpg" found on $PATH when
@@@ -1361,6 -1348,12 +1361,12 @@@ help.autocorrect:
        value is 0 - the command will be just shown but not executed.
        This is the default.
  
+ help.htmlpath::
+       Specify the path where the HTML documentation resides. File system paths
+       and URLs are supported. HTML pages will be prefixed with this path when
+       help is displayed in the 'web' format. This defaults to the documentation
+       path of your Git installation.
  http.proxy::
        Override the HTTP proxy, normally configured using the 'http_proxy',
        'https_proxy', and 'all_proxy' environment variables (see
@@@ -1527,14 -1520,6 +1533,14 @@@ mailmap.file:
        subdirectory, or somewhere outside of the repository itself.
        See linkgit:git-shortlog[1] and linkgit:git-blame[1].
  
 +mailmap.blob::
 +      Like `mailmap.file`, but consider the value as a reference to a
 +      blob in the repository. If both `mailmap.file` and
 +      `mailmap.blob` are given, both are parsed, with entries from
 +      `mailmap.file` taking precedence. In a bare repository, this
 +      defaults to `HEAD:.mailmap`. In a non-bare repository, it
 +      defaults to empty.
 +
  man.viewer::
        Specify the programs that may be used to display help in the
        'man' format. See linkgit:git-help[1].
@@@ -2013,12 -1998,6 +2019,12 @@@ submodule.<name>.update:
        URL and other values found in the `.gitmodules` file.  See
        linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
  
 +submodule.<name>.branch::
 +      The remote branch name for a submodule, used by `git submodule
 +      update --remote`.  Set this option to override the value found in
 +      the `.gitmodules` file.  See linkgit:git-submodule[1] and
 +      linkgit:gitmodules[5] for details.
 +
  submodule.<name>.fetchRecurseSubmodules::
        This option can be used to control recursive fetching of this
        submodule. It can be overridden by using the --[no-]recurse-submodules