Merge branch 'jn/maint-doc-dashdash' into jn/doc-dashdash
authorJunio C Hamano <gitster@pobox.com>
Wed, 29 Jun 2011 16:25:51 +0000 (09:25 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 29 Jun 2011 16:25:51 +0000 (09:25 -0700)
* jn/maint-doc-dashdash:
Documentation: quote double-dash for AsciiDoc

1  2 
Documentation/config.txt
Documentation/git-commit.txt
Documentation/git-mergetool--lib.txt
Documentation/git-revert.txt
Documentation/git-submodule.txt
Documentation/git-web--browse.txt
Documentation/rev-list-options.txt
diff --combined Documentation/config.txt
index 6b937771994f5b0a532b6f2cc522a9d3f35c9c09,c2ba535a0d1c823ca3200705100c62be3d9990a9..98eb4d97153c84f529fe7e935719dd79b5efa50c
@@@ -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
@@@ -676,7 -676,7 +676,7 @@@ branch.<name>.rebase:
  browser.<tool>.cmd::
        Specify the command to invoke the specified browser. The
        specified command is evaluated in shell with the URLs passed
-       as arguments. (See linkgit:git-web--browse[1].)
+       as arguments. (See linkgit:git-web{litdd}browse[1].)
  
  browser.<tool>.path::
        Override the path for the given tool that may be used to
@@@ -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
@@@ -847,13 -897,9 +847,13 @@@ diff.wordRegex:
        characters are *ignorable* whitespace.
  
  fetch.recurseSubmodules::
 -      A boolean value which changes the behavior for fetch and pull, the
 -      default is to not recursively fetch populated submodules unless
 -      configured otherwise.
 +      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
 +      unconditionally recurse into submodules when set to true or to not
 +      recurse at all when set to false. When set to 'on-demand' (the default
 +      value), fetch and pull will only recurse into a populated submodule
 +      when its superproject retrieves a commit that updates the submodule's
 +      reference.
  
  fetch.unpackLimit::
        If the number of objects fetched over the git native
@@@ -927,16 -973,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
@@@ -1062,12 -1098,6 +1062,12 @@@ All gitcvs variables except for 'gitcvs
  is one of "ext" and "pserver") to make them apply only for the given
  access method.
  
 +grep.lineNumber::
 +      If set to true, enable '-n' option by default.
 +
 +grep.extendedRegexp::
 +      If set to true, enable '--extended-regexp' option by default.
 +
  gui.commitmsgwidth::
        Defines how wide the commit message window is in the
        linkgit:git-gui[1]. "75" is the default.
@@@ -1309,16 -1339,9 +1309,16 @@@ 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
 -      ignored if portable keystroke input is not available.
 +      Currently this is used by the `\--patch` mode of
 +      linkgit:git-add[1], linkgit:git-checkout[1], linkgit:git-commit[1],
 +      linkgit:git-reset[1], and linkgit:git-stash[1]. Note that this
 +      setting is silently ignored if portable keystroke input
 +      is not available.
 +
 +log.abbrevCommit::
 +      If true, makes linkgit:git-log[1], linkgit:git-show[1], and
 +      linkgit:git-whatchanged[1] assume `\--abbrev-commit`. You may
 +      override this option with `\--no-abbrev-commit`.
  
  log.date::
        Set the default date-time mode for the 'log' command.
@@@ -1794,7 -1817,7 +1794,7 @@@ submodule.<name>.update:
        linkgit:git-submodule[1] and linkgit:gitmodules[5] for details.
  
  submodule.<name>.fetchRecurseSubmodules::
 -      This option can be used to enable/disable recursive fetching of this
 +      This option can be used to control recursive fetching of this
        submodule. It can be overridden by using the --[no-]recurse-submodules
        command line option to "git fetch" and "git pull".
        This setting will override that from in the linkgit:gitmodules[5]
index 7951cb7b005bf472c449a563d073036ceb8b921a,b9aa220db8fa1d0eb23535c15ef2350e44cd545c..5cc84a139133dca2fdcb594007c8b0d6464d5ca8
@@@ -8,12 -8,11 +8,12 @@@ git-commit - Record changes to the repo
  SYNOPSIS
  --------
  [verse]
 -'git commit' [-a | --interactive] [-s] [-v] [-u<mode>] [--amend] [--dry-run]
 -         [(-c | -C | --fixup | --squash) <commit>] [-F <file> | -m <msg>]
 -         [--reset-author] [--allow-empty] [--allow-empty-message] [--no-verify]
 -         [-e] [--author=<author>] [--date=<date>] [--cleanup=<mode>]
 -         [--status | --no-status] [-i | -o] [--] [<file>...]
 +'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
 +         [--dry-run] [(-c | -C | --fixup | --squash) <commit>]
 +         [-F <file> | -m <msg>] [--reset-author] [--allow-empty]
 +         [--allow-empty-message] [--no-verify] [-e] [--author=<author>]
 +         [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
 +         [-i | -o] [--] [<file>...]
  
  DESCRIPTION
  -----------
@@@ -40,10 -39,9 +40,10 @@@ The content to be added can be specifie
     that have been removed from the working tree, and then perform the
     actual commit;
  
 -5. by using the --interactive switch with the 'commit' command to decide one
 -   by one which files should be part of the commit, before finalizing the
 -   operation.  Currently, this is done by invoking 'git add --interactive'.
 +5. by using the --interactive or --patch switches with the 'commit' command
 +   to decide one by one which files or hunks should be part of the commit,
 +   before finalizing the operation. See the ``Interactive Mode`` section of
 +   linkgit:git-add[1] to learn how to operate these modes.
  
  The `--dry-run` option can be used to obtain a
  summary of what is included by any of the above for the next
@@@ -61,12 -59,6 +61,12 @@@ OPTION
        been modified and deleted, but new files you have not
        told git about are not affected.
  
 +-p::
 +--patch::
 +      Use the interactive patch selection interface to chose
 +      which changes to commit. See linkgit:git-add[1] for
 +      details.
 +
  -C <commit>::
  --reuse-message=<commit>::
        Take an existing commit object, and reuse the log message
        linkgit:git-rebase[1] for details.
  
  --reset-author::
 -      When used with -C/-c/--amend options, declare that the
 -      authorship of the resulting commit now belongs of the committer.
 -      This also renews the author timestamp.
 +      When used with -C/-c/--amend options, or when committing after a
 +      a conflicting cherry-pick, declare that the authorship of the
 +      resulting commit now belongs of the committer. This also renews
 +      the author timestamp.
  
  --short::
        When doing a dry-run, give the output in the short-format. See
@@@ -284,7 -275,7 +284,7 @@@ When recording your own work, the conte
  your working tree are temporarily stored to a staging area
  called the "index" with 'git add'.  A file can be
  reverted back, only in the index but not in the working tree,
- to that of the last commit with `git reset HEAD -- <file>`,
+ to that of the last commit with `git reset HEAD \-- <file>`,
  which effectively reverts 'git add' and prevents the changes to
  this file from participating in the next commit.  After building
  the state to be committed incrementally with these commands,
@@@ -405,6 -396,12 +405,6 @@@ linkgit:git-mv[1]
  linkgit:git-merge[1],
  linkgit:git-commit-tree[1]
  
 -Author
 -------
 -Written by Linus Torvalds <torvalds@osdl.org> and
 -Junio C Hamano <gitster@pobox.com>
 -
 -
  GIT
  ---
  Part of the linkgit:git[1] suite
index 63ededec1d7099bb2156461895f32dcf008dedcc,1441aec2426363eeab9e4de6aae20f0d1bc400b8..5b0d51f7f8cfc52739463dd90827fe5d0dc1b58c
@@@ -7,7 -7,7 +7,7 @@@ git-mergetool--lib - Common git merge t
  
  SYNOPSIS
  --------
- 'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool--lib"'
+ 'TOOL_MODE=(diff|merge) . "$(git --exec-path)/git-mergetool{litdd}lib"'
  
  DESCRIPTION
  -----------
@@@ -41,6 -41,14 +41,6 @@@ run_merge_tool:
        '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
        for use by the merge tool.
  
 -Author
 -------
 -Written by David Aguilar <davvid@gmail.com>
 -
 -Documentation
 ---------------
 -Documentation by David Aguilar and the git-list <git@vger.kernel.org>.
 -
  GIT
  ---
  Part of the linkgit:git[1] suite
index ac10cfbb14aba460973019d712ee90e8804de34d,ab994abdbd586bab87f6f37a39a9da576bd03c2f..6a21b37f95986ad04140be4cbef3ba011cbe5220
@@@ -23,7 -23,7 +23,7 @@@ throw away all uncommitted changes in y
  should see linkgit:git-reset[1], particularly the '--hard' option.  If
  you want to extract specific files as they were in another commit, you
  should see linkgit:git-checkout[1], specifically the `git checkout
- <commit> -- <filename>` syntax.  Take care with these alternatives as
+ <commit> \-- <filename>` syntax.  Take care with these alternatives as
  both will discard uncommitted changes in your working directory.
  
  OPTIONS
@@@ -80,16 -80,6 +80,16 @@@ effect to your index in a row
  --signoff::
        Add Signed-off-by line at the end of the commit message.
  
 +--strategy=<strategy>::
 +      Use the given merge strategy.  Should only be used once.
 +      See the MERGE STRATEGIES section in linkgit:git-merge[1]
 +      for details.
 +
 +-X<option>::
 +--strategy-option=<option>::
 +      Pass the merge strategy-specific option through to the
 +      merge strategy.  See linkgit:git-merge[1] for details.
 +
  EXAMPLES
  --------
  git revert HEAD~3::
@@@ -105,6 -95,14 +105,6 @@@ git revert -n master{tilde}5..master{ti
        changes. The revert only modifies the working tree and the
        index.
  
 -Author
 -------
 -Written by Junio C Hamano <gitster@pobox.com>
 -
 -Documentation
 ---------------
 -Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 -
  SEE ALSO
  --------
  linkgit:git-cherry-pick[1]
index 5e7a4130eeec48c27abf92b37834613692446723,1649b9fee94759f94e2c11577f4c68426cea8d8c..12af4de5e1e156d01c5953b1023867b9d29ba848
@@@ -172,7 -172,7 +172,7 @@@ sync:
        repositories accordingly.
  +
  "git submodule sync" synchronizes all submodules while
- "git submodule sync -- A" synchronizes submodule "A" only.
+ "git submodule sync \-- A" synchronizes submodule "A" only.
  
  OPTIONS
  -------
  
  -f::
  --force::
 -      This option is only valid for the add command.
 -      Allow adding an otherwise ignored submodule path.
 +      This option is only valid for add and update commands.
 +      When running add, allow adding an otherwise ignored submodule path.
 +      When running update, throw away local changes in submodules when
 +      switching to a different commit.
  
  --cached::
        This option is only valid for status and summary commands.  These
@@@ -260,6 -258,11 +260,6 @@@ This file should be formatted in the sa
  to each submodule url is "submodule.$name.url".  See linkgit:gitmodules[5]
  for details.
  
 -
 -AUTHOR
 -------
 -Written by Lars Hjemli <hjemli@gmail.com>
 -
  GIT
  ---
  Part of the linkgit:git[1] suite
index 69d92fa00ef91dff0346925ba1c50857132e9c03,a7b1201bbb18453ef6ba4f3db20901438d7086d9..9b0d1fe395df42d18ee47bb2c1c2a207639c85b8
@@@ -68,7 -68,7 +68,7 @@@ browser.<tool>.pat
  You can explicitly provide a full path to your preferred browser by
  setting the configuration variable 'browser.<tool>.path'. For example,
  you can configure the absolute path to firefox by setting
- 'browser.firefox.path'. Otherwise, 'git web--browse' assumes the tool
+ 'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
  is available in PATH.
  
  browser.<tool>.cmd
@@@ -116,6 -116,16 +116,6 @@@ $ git config --global web.browser firef
  as they are probably more user specific than repository specific.
  See linkgit:git-config[1] for more information about this.
  
 -Author
 -------
 -Written by Christian Couder <chriscool@tuxfamily.org> and the git-list
 -<git@vger.kernel.org>, based on 'git mergetool' by Theodore Y. Ts'o.
 -
 -Documentation
 --------------
 -Documentation by Christian Couder <chriscool@tuxfamily.org> and the
 -git-list <git@vger.kernel.org>.
 -
  GIT
  ---
  Part of the linkgit:git[1] suite
index 7e7ba68781f98b55f4189fe0fb4dd6e96c47c0af,97fd1d0e908b6d0f711147cf13604d1ac475faa0..554ab8c88bdef6bb64ba9496295b563083657077
@@@ -72,26 -72,11 +72,26 @@@ endif::git-rev-list[
  
  --merges::
  
 -      Print only merge commits.
 +      Print only merge commits. This is exactly the same as `--min-parents=2`.
  
  --no-merges::
  
 -      Do not print commits with more than one parent.
 +      Do not print commits with more than one parent. This is
 +      exactly the same as `--max-parents=1`.
 +
 +--min-parents=<number>::
 +--max-parents=<number>::
 +--no-min-parents::
 +--no-max-parents::
 +
 +      Show only commits which have at least (or at most) that many
 +      commits. In particular, `--max-parents=1` is the same as `--no-merges`,
 +      `--min-parents=2` is the same as `--merges`.  `--max-parents=0`
 +      gives all root commits and `--min-parents=3` all octopus merges.
 ++
 +`--no-min-parents` and `--no-max-parents` reset these limits (to no limit)
 +again.  Equivalent forms are `--min-parents=0` (any commit has 0 or more
 +parents) and `--max-parents=-1` (negative numbers denote no upper limit).
  
  --first-parent::
        Follow only the first parent commit upon seeing a merge
        is automatically prepended if missing. If pattern lacks '?', '*',
        or '[', '/*' at the end is implied.
  
 +--ignore-missing::
 +
 +      Upon seeing an invalid object name in the input, pretend as if
 +      the bad input was not given.
  
  ifndef::git-rev-list[]
  --bisect::
@@@ -170,11 -151,6 +170,11 @@@ ifdef::git-rev-list[
        to /dev/null as the output does not have to be formatted.
  endif::git-rev-list[]
  
 +--cherry-mark::
 +
 +      Like `--cherry-pick` (see below) but mark equivalent commits
 +      with `=` rather than omitting them, and inequivalent ones with `+`.
 +
  --cherry-pick::
  
        Omit any commit that introduces the same change as
@@@ -189,27 -165,6 +189,27 @@@ from the other branch (for example, "3r
  from branch A).  With this option, such pairs of commits are
  excluded from the output.
  
 +--left-only::
 +--right-only::
 +
 +      List only commits on the respective side of a symmetric range,
 +      i.e. only those which would be marked `<` resp. `>` by
 +      `--left-right`.
 ++
 +For example, `--cherry-pick --right-only A...B` omits those
 +commits from `B` which are in `A` or are patch-equivalent to a commit in
 +`A`. In other words, this lists the `{plus}` commits from `git cherry A B`.
 +More precisely, `--cherry-pick --right-only --no-merges` gives the exact
 +list.
 +
 +--cherry::
 +
 +      A synonym for `--right-only --cherry-mark --no-merges`; useful to
 +      limit the output to the commits on our side and mark those that
 +      have been applied to the other side of a forked history with
 +      `git log --cherry upstream...mybranch`, similar to
 +      `git cherry upstream mybranch`.
 +
  -g::
  --walk-reflogs::
  
@@@ -313,7 -268,7 +313,7 @@@ that you are filtering for a file `foo
         \   /   /   /   /
          `-------------'
  -----------------------------------------------------------------------
- The horizontal line of history A--P is taken to be the first parent of
+ The horizontal line of history A---P is taken to be the first parent of
  each merge.  The commits are:
  
  * `I` is the initial commit, in which `foo` exists with contents
@@@ -734,10 -689,7 +734,10 @@@ ifdef::git-rev-list[
        Print a number stating how many commits would have been
        listed, and suppress all other output.  When used together
        with '--left-right', instead print the counts for left and
 -      right commits, separated by a tab.
 +      right commits, separated by a tab. When used together with
 +      '--cherry-mark', omit patch equivalent commits from these
 +      counts and print the count for equivalent commits separated
 +      by a tab.
  endif::git-rev-list[]