Code

Merge branch 'vh/config-interactive-singlekey-doc'
authorJunio C Hamano <gitster@pobox.com>
Wed, 11 May 2011 18:38:06 +0000 (11:38 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 11 May 2011 18:38:06 +0000 (11:38 -0700)
* vh/config-interactive-singlekey-doc:
  git-reset.txt: better docs for '--patch'
  git-checkout.txt: better docs for '--patch'
  git-stash.txt: better docs for '--patch'
  git-add.txt: document 'interactive.singlekey'
  config.txt: 'interactive.singlekey; is used by...

1  2 
Documentation/config.txt
Documentation/git-add.txt

diff --combined Documentation/config.txt
index c96aec10d8124f77f558e4ee5fa0f277ccb7b3d3,1b1d80d84a938932ac1df9244b7e56564053f77a..285c7f73ca1b7a2a63b549a6cacec4cc77ad5ad7
@@@ -442,6 -442,8 +442,6 @@@ for most projects as source code and ot
  be delta compressed, but larger binary media files won't be.
  +
  Common unit suffixes of 'k', 'm', or 'g' are supported.
 -+
 -Currently only linkgit:git-fast-import[1] honors this setting.
  
  core.excludesfile::
        In addition to '.gitignore' (per-directory) and
@@@ -587,8 -589,6 +587,8 @@@ it will be treated as a shell command
  "gitk --all --not ORIG_HEAD".  Note that shell commands will be
  executed from the top-level directory of a repository, which may
  not necessarily be the current directory.
 +'GIT_PREFIX' is set as returned by running 'git rev-parse --show-prefix'
 +from the original current directory. See linkgit:git-rev-parse[1].
  
  am.keepcr::
        If true, git-am will call git-mailsplit for patches in mbox format
@@@ -643,7 -643,7 +643,7 @@@ branch.<name>.remote:
  
  branch.<name>.merge::
        Defines, together with branch.<name>.remote, the upstream branch
 -      for the given branch. It tells 'git fetch'/'git pull' which
 +      for the given branch. It tells 'git fetch'/'git pull'/'git rebase' which
        branch to merge and can also affect 'git push' (see push.default).
        When in branch <name>, it tells 'git fetch' the default
        refspec to be marked for merging in FETCH_HEAD. The value is
@@@ -708,16 -708,9 +708,16 @@@ second is the background.  The positio
  doesn't matter.
  
  color.diff::
 -      When set to `always`, always use colors in patch.
 -      When false (or `never`), never.  When set to `true` or `auto`, use
 -      colors only when the output is to the terminal. Defaults to false.
 +      Whether to use ANSI escape sequences to add color to patches.
 +      If this is set to `always`, linkgit:git-diff[1],
 +      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.
 ++
 +This does not affect linkgit:git-format-patch[1] nor the
 +'git-diff-{asterisk}' plumbing commands.  Can be overridden on the
 +command line with the `--color[=<when>]` option.
  
  color.diff.<slot>::
        Use customized color for diff colorization.  `<slot>` specifies
@@@ -803,15 -796,11 +803,15 @@@ color.status.<slot>:
        color.branch.<slot>.
  
  color.ui::
 -      When set to `always`, always use colors in all git commands which
 -      are capable of colored output. When false (or `never`), never. When
 -      set to `true` or `auto`, use colors only when the output is to the
 -      terminal. When more specific variables of color.* are set, they always
 -      take precedence over this setting. Defaults to false.
 +      This variable determines the default value for variables such
 +      as `color.diff` and `color.grep` that control the use of color
 +      per command family. Its scope will expand as more commands learn
 +      configuration to set a default for the `--color` option.  Set it
 +      to `always` if you want all output not intended for machine
 +      consumption to use color, to `true` or `auto` if you want such
 +      output to use color when written to the terminal, or to `false` or
 +      `never` if you prefer git commands not to use color unless enabled
 +      explicitly with some other configuration or the `--color` option.
  
  commit.status::
        A boolean to enable/disable inclusion of status information in the
@@@ -823,7 -812,68 +823,7 @@@ commit.template:
        "{tilde}/" is expanded to the value of `$HOME` and "{tilde}user/" to the
        specified user's home directory.
  
 -diff.autorefreshindex::
 -      When using 'git diff' to compare with work tree
 -      files, do not consider stat-only change as changed.
 -      Instead, silently run `git update-index --refresh` to
 -      update the cached stat information for paths whose
 -      contents in the work tree match the contents in the
 -      index.  This option defaults to true.  Note that this
 -      affects only 'git diff' Porcelain, and not lower level
 -      'diff' commands such as 'git diff-files'.
 -
 -diff.external::
 -      If this config variable is set, diff generation is not
 -      performed using the internal diff machinery, but using the
 -      given command.  Can be overridden with the `GIT_EXTERNAL_DIFF'
 -      environment variable.  The command is called with parameters
 -      as described under "git Diffs" in linkgit:git[1].  Note: if
 -      you want to use an external diff program only on a subset of
 -      your files, you might want to use linkgit:gitattributes[5] instead.
 -
 -diff.mnemonicprefix::
 -      If set, 'git diff' uses a prefix pair that is different from the
 -      standard "a/" and "b/" depending on what is being compared.  When
 -      this configuration is in effect, reverse diff output also swaps
 -      the order of the prefixes:
 -`git diff`;;
 -      compares the (i)ndex and the (w)ork tree;
 -`git diff HEAD`;;
 -       compares a (c)ommit and the (w)ork tree;
 -`git diff --cached`;;
 -      compares a (c)ommit and the (i)ndex;
 -`git diff HEAD:file1 file2`;;
 -      compares an (o)bject and a (w)ork tree entity;
 -`git diff --no-index a b`;;
 -      compares two non-git things (1) and (2).
 -
 -diff.noprefix::
 -      If set, 'git diff' does not show any source or destination prefix.
 -
 -diff.renameLimit::
 -      The number of files to consider when performing the copy/rename
 -      detection; equivalent to the 'git diff' option '-l'.
 -
 -diff.renames::
 -      Tells git to detect renames.  If set to any boolean value, it
 -      will enable basic rename detection.  If set to "copies" or
 -      "copy", it will detect copies, as well.
 -
 -diff.ignoreSubmodules::
 -      Sets the default value of --ignore-submodules. Note that this
 -      affects only 'git diff' Porcelain, and not lower level 'diff'
 -      commands such as 'git diff-files'. 'git checkout' also honors
 -      this setting when reporting uncommitted changes.
 -
 -diff.suppressBlankEmpty::
 -      A boolean to inhibit the standard behavior of printing a space
 -      before each empty output line. Defaults to false.
 -
 -diff.tool::
 -      Controls which diff tool is used.  `diff.tool` overrides
 -      `merge.tool` when used by linkgit:git-difftool[1] and has
 -      the same valid values as `merge.tool` minus "tortoisemerge"
 -      and plus "kompare".
 +include::diff-config.txt[]
  
  difftool.<tool>.path::
        Override the path for the given tool.  This is useful in case
@@@ -927,16 -977,6 +927,16 @@@ format.signoff:
      the rights to submit this work under the same open source license.
      Please see the 'SubmittingPatches' document for further discussion.
  
 +filter.<driver>.clean::
 +      The command which is used to convert the content of a worktree
 +      file to a blob upon checkin.  See linkgit:gitattributes[5] for
 +      details.
 +
 +filter.<driver>.smudge::
 +      The command which is used to convert the content of a blob
 +      object to a worktree file upon checkout.  See
 +      linkgit:gitattributes[5] for details.
 +
  gc.aggressiveWindow::
        The window size parameter used in the delta compression
        algorithm used by 'git gc --aggressive'.  This defaults
@@@ -1309,8 -1349,9 +1309,9 @@@ instaweb.port:
  interactive.singlekey::
        In interactive commands, allow the user to provide one-letter
        input with a single key (i.e., without hitting enter).
-       Currently this is used only by the `\--patch` mode of
-       linkgit:git-add[1].  Note that this setting is silently
+       Currently this is used by the `\--patch` mode of
+       linkgit:git-add[1], linkgit:git-reset[1], linkgit:git-stash[1] and
+       linkgit:git-checkout[1]. Note that this setting is silently
        ignored if portable keystroke input is not available.
  
  log.date::
index 35cb5d3f643905d124445ecdae3d2949ac0067a6,f072b5964db0c9daa440feca56fccb7d305f1ae2..9c1d3957223355e00eea917d4a7dff6d50343f32
@@@ -134,8 -134,6 +134,8 @@@ subdirectories
        If some files could not be added because of errors indexing
        them, do not abort the operation, but continue adding the
        others. The command shall still exit with non-zero status.
 +      The configuration variable `add.ignoreErrors` can be set to
 +      true to make this the default behaviour.
  
  --ignore-missing::
        This option can only be used together with --dry-run. By using
@@@ -274,7 -272,8 +274,8 @@@ patch:
    This lets you choose one path out of a 'status' like selection.
    After choosing the path, it presents the diff between the index
    and the working tree file and asks you if you want to stage
-   the change of each hunk.  You can say:
+   the change of each hunk.  You can select one of the following
+   options and type return:
  
         y - stage this hunk
         n - do not stage this hunk
  +
  After deciding the fate for all hunks, if there is any hunk
  that was chosen, the index is updated with the selected hunks.
+ +
+ You can omit having to type return here, by setting the configuration
+ variable `interactive.singlekey` to `true`.
  
  diff::