From: Junio C Hamano <gitster@pobox.com>
Date: Tue, 17 May 2016 21:38:31 +0000 (-0700)
Subject: Merge branch 'jc/linkgit-fix'
X-Git-Tag: v2.9.0-rc0~27
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/5f232ecfdf2982adf67af5f9b7aaf05da13a155c?hp=-c

Merge branch 'jc/linkgit-fix'

Many 'linkgit:<git documentation page>' references were broken,
which are all fixed with this.

* jc/linkgit-fix:
Documentation: fix linkgit references
---

5f232ecfdf2982adf67af5f9b7aaf05da13a155c
diff --combined Documentation/config.txt
index e718410350,4b57519e42..3127aed1d8
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@@ -81,16 -81,13 +81,16 @@@ Include
  
  You can include one config file from another by setting the special
  `include.path` variable to the name of the file to be included. The
 +variable takes a pathname as its value, and is subject to tilde
 +expansion.
 +
 +The
  included file is expanded immediately, as if its contents had been
  found at the location of the include directive. If the value of the
  `include.path` variable is a relative path, the path is considered to be
  relative to the configuration file in which the include directive was
 -found. The value of `include.path` is subject to tilde expansion: `~/`
 -is expanded to the value of `$HOME`, and `~user/` to the specified
 -user's home directory. See below for examples.
 +found.  See below for examples.
 +
  
  Example
  ~~~~~~~
@@@ -117,7 -114,7 +117,7 @@@
  	[include]
  		path = /path/to/foo.inc ; include by absolute path
  		path = foo ; expand "foo" relative to the current file
 -		path = ~/foo ; expand "foo" in your $HOME directory
 +		path = ~/foo ; expand "foo" in your `$HOME` directory
  
  
  Values
@@@ -172,13 -169,6 +172,13 @@@ thing on the same output line (e.g. ope
  list of branch names in `log --decorate` output) is set to be
  painted with `bold` or some other attribute.
  
 +pathname::
 +	A variable that takes a pathname value can be given a
 +	string that begins with "`~/`" or "`~user/`", and the usual
 +	tilde expansion happens to such a string: `~/`
 +	is expanded to the value of `$HOME`, and `~user/` to the
 +	specified user's home directory.
 +
  
  Variables
  ~~~~~~~~~
@@@ -496,10 -486,10 +496,10 @@@ repository's usual working tree)
  
  core.logAllRefUpdates::
  	Enable the reflog. Updates to a ref <ref> is logged to the file
 -	"$GIT_DIR/logs/<ref>", by appending the new and old
 +	"`$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.
@@@ -603,11 -593,12 +603,11 @@@ be delta compressed, but larger binary 
  Common unit suffixes of 'k', 'm', or 'g' are supported.
  
  core.excludesFile::
 -	In addition to '.gitignore' (per-directory) and
 -	'.git/info/exclude', Git looks into this file for patterns
 -	of files which are not meant to be tracked.  "`~/`" is expanded
 -	to the value of `$HOME` and "`~user/`" to the specified user's
 -	home directory. Its default value is $XDG_CONFIG_HOME/git/ignore.
 -	If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/ignore
 +	Specifies the pathname to the file that contains patterns to
 +	describe paths that are not meant to be tracked, in addition
 +	to '.gitignore' (per-directory) and '.git/info/exclude'.
 +	Defaults to `$XDG_CONFIG_HOME/git/ignore`.
 +	If `$XDG_CONFIG_HOME` is either not set or empty, `$HOME/.config/git/ignore`
  	is used instead. See linkgit:gitignore[5].
  
  core.askPass::
@@@ -624,25 -615,8 +624,25 @@@ core.attributesFile:
  	'.git/info/attributes', Git looks into this file for attributes
  	(see linkgit:gitattributes[5]). Path expansions are made the same
  	way as for `core.excludesFile`. Its default value is
 -	$XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME is either not
 -	set or empty, $HOME/.config/git/attributes is used instead.
 +	`$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME` is either not
 +	set or empty, `$HOME/.config/git/attributes` is used instead.
 +
 +core.hooksPath::
 +	By default Git will look for your hooks in the
 +	'$GIT_DIR/hooks' directory. Set this to different path,
 +	e.g. '/etc/git/hooks', and Git will try to find your hooks in
 +	that directory, e.g. '/etc/git/hooks/pre-receive' instead of
 +	in '$GIT_DIR/hooks/pre-receive'.
 ++
 +The path can be either absolute or relative. A relative path is
 +taken as relative to the directory where the hooks are run (see
 +the "DESCRIPTION" section of linkgit:githooks[5]).
 ++
 +This configuration variable is useful in cases where you'd like to
 +centrally configure your Git hooks instead of configuring them on a
 +per-repository basis, or as a more flexible and centralized
 +alternative to having an `init.templateDir` where you've changed
 +default hooks.
  
  core.editor::
  	Commands such as `commit` and `tag` that lets you edit
@@@ -1132,15 -1106,15 +1132,15 @@@ commit.status:
  	message.  Defaults to true.
  
  commit.template::
 -	Specify a file to use as the template for new commit messages.
 -	"`~/`" is expanded to the value of `$HOME` and "`~user/`" to the
 -	specified user's home directory.
 +	Specify the pathname of a file to use as the template for
 +	new commit messages.
  
  credential.helper::
  	Specify an external helper to be called when a username or
  	password credential is needed; the helper may consult external
 -	storage to avoid prompting the user for the credentials. See
 -	linkgit:gitcredentials[7] for details.
 +	storage to avoid prompting the user for the credentials. Note
 +	that multiple helpers may be defined. See linkgit:gitcredentials[7]
 +	for details.
  
  credential.useHttpPath::
  	When acquiring credentials, consider the "path" component of an http
@@@ -1360,7 -1334,7 +1360,7 @@@ gc.worktreePruneExpire:
  	'git worktree prune --expire 3.months.ago'.
  	This config variable can be used to set a different grace
  	period. The value "now" may be used to disable the grace
 -	period and prune $GIT_DIR/worktrees immediately, or "never"
 +	period and prune `$GIT_DIR/worktrees` immediately, or "never"
  	may be used to suppress pruning.
  
  gc.reflogExpire::
@@@ -1500,13 -1474,13 +1500,13 @@@ grep.fallbackToNoIndex:
  	is executed outside of a git repository.  Defaults to false.
  
  gpg.program::
 -	Use this custom program instead of "gpg" found on $PATH when
 +	Use this custom program instead of "`gpg`" found on `$PATH` when
  	making or verifying a PGP signature. The program must support the
  	same command-line interface as GPG, namely, to verify a detached
 -	signature, "gpg --verify $file - <$signature" is run, and the
 +	signature, "`gpg --verify $file - <$signature`" is run, and the
  	program is expected to signal a good signature by exiting with
  	code 0, and to generate an ASCII-armored detached signature, the
 -	standard input of "gpg -bsau $key" is fed with the contents to be
 +	standard input of "`gpg -bsau $key`" is fed with the contents to be
  	signed, and the program is expected to send the result to its
  	standard output.
  
@@@ -1519,7 -1493,7 +1519,7 @@@ gui.diffContext:
  	made by the linkgit:git-gui[1]. The default is "5".
  
  gui.displayUntracked::
- 	Determines if linkgit::git-gui[1] shows untracked files
+ 	Determines if linkgit:git-gui[1] shows untracked files
  	in the file list. The default is "true".
  
  gui.encoding::
@@@ -1680,19 -1654,12 +1680,19 @@@ http.emptyAuth:
  	a username in the URL, as libcurl normally requires a username for
  	authentication.
  
 +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
 +	headers.  To allow overriding the settings inherited from the system
 +	config, an empty value will reset the extra headers to the empty list.
 +
  http.cookieFile::
 -	File containing previously stored cookie lines which should be used
 +	The pathname of a file containing previously stored cookie lines,
 +	which should be used
  	in the Git http session, if they match the server. The file format
  	of the file to read cookies from should be plain HTTP headers or
- 	the Netscape/Mozilla cookie file format (see linkgit:curl[1]).
+ 	the Netscape/Mozilla cookie file format (see `curl(1)`).
 -	NOTE that the file specified with http.cookieFile is only used as
 +	NOTE that the file specified with http.cookieFile is used only as
  	input unless http.saveCookies is set.
  
  http.saveCookies::
@@@ -1919,14 -1886,6 +1919,14 @@@ interactive.singleKey:
  	setting is silently ignored if portable keystroke input
  	is not available; requires the Perl module Term::ReadKey.
  
 +interactive.diffFilter::
 +	When an interactive command (such as `git add --patch`) shows
 +	a colorized diff, git will pipe the diff through the shell
 +	command defined by this configuration variable. The command may
 +	mark up the diff further for human consumption, provided that it
 +	retains a one-to-one correspondence with the lines in the
 +	original diff. Defaults to disabled (no filtering).
 +
  log.abbrevCommit::
  	If true, makes linkgit:git-log[1], linkgit:git-show[1], and
  	linkgit:git-whatchanged[1] assume `--abbrev-commit`. You may
@@@ -2188,11 -2147,8 +2188,11 @@@ pack.packSizeLimit:
  	The maximum size of a pack.  This setting only affects
  	packing to a file when repacking, i.e. the git:// protocol
  	is unaffected.  It can be overridden by the `--max-pack-size`
 -	option of linkgit:git-repack[1]. The minimum size allowed is
 -	limited to 1 MiB. The default is unlimited.
 +	option of linkgit:git-repack[1].  Reaching this limit results
 +	in the creation of multiple packfiles; which in turn prevents
 +	bitmaps from being created.
 +	The minimum size allowed is limited to 1 MiB.
 +	The default is unlimited.
  	Common unit suffixes of 'k', 'm', or 'g' are
  	supported.
  
@@@ -2592,9 -2548,8 +2592,9 @@@ repack.writeBitmaps:
  	objects to disk (e.g., when `git repack -a` is run).  This
  	index can speed up the "counting objects" phase of subsequent
  	packs created for clones and fetches, at the cost of some disk
 -	space and extra time spent on the initial repack.  Defaults to
 -	false.
 +	space and extra time spent on the initial repack.  This has
 +	no effect if multiple packfiles are created.
 +	Defaults to false.
  
  rerere.autoUpdate::
  	When set to true, `git-rerere` updates the index with the
@@@ -2774,17 -2729,6 +2774,17 @@@ submodule.<name>.ignore:
  	"--ignore-submodules" option. The 'git submodule' commands are not
  	affected by this setting.
  
 +submodule.fetchJobs::
 +	Specifies how many submodules are fetched/cloned at the same time.
 +	A positive integer allows up to that number of submodules fetched
 +	in parallel. A value of 0 will give some reasonable default.
 +	If unset, it defaults to 1.
 +
 +tag.forceSignAnnotated::
 +	A boolean to specify whether annotated tags created should be GPG signed.
 +	If `--annotate` is specified on the command line, it takes
 +	precedence over this option.
 +
  tag.sort::
  	This variable controls the sort ordering of tags when displayed by
  	linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the