From: Junio C Hamano <gitster@pobox.com>
Date: Wed, 26 Apr 2017 06:39:07 +0000 (+0900)
Subject: Merge branch 'ss/submodule-shallow-doc'
X-Git-Tag: v2.13.0-rc1~9
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/864033a3833d6d0f90bf5a2bd1128b295c1041a7?ds=inline;hp=-c

Merge branch 'ss/submodule-shallow-doc'

Doc update.

* ss/submodule-shallow-doc:
gitmodules: clarify what history depth a shallow clone has
---

864033a3833d6d0f90bf5a2bd1128b295c1041a7
diff --combined Documentation/gitmodules.txt
index 470062413f,6f39f247a0..db5d47eb19
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@@ -66,26 -66,17 +66,26 @@@ submodule.<name>.fetchRecurseSubmodules
  
  submodule.<name>.ignore::
  	Defines under what circumstances "git status" and the diff family show
 -	a submodule as modified. When set to "all", it will never be considered
 -	modified (but will nonetheless show up in the output of status and
 -	commit when it has been staged), "dirty" will ignore all changes
 -	to the submodules work tree and
 -	takes only differences between the HEAD of the submodule and the commit
 -	recorded in the superproject into account. "untracked" will additionally
 -	let submodules with modified tracked files in their work tree show up.
 -	Using "none" (the default when this option is not set) also shows
 -	submodules that have untracked files in their work tree as changed.
 -	If this option is also present in the submodules entry in .git/config of
 -	the superproject, the setting there will override the one found in
 +	a submodule as modified. The following values are supported:
 +
 +	all;; The submodule will never be considered modified (but will
 +	    nonetheless show up in the output of status and commit when it has
 +	    been staged).
 +
 +	dirty;; All changes to the submodule's work tree will be ignored, only
 +	    committed differences between the HEAD of the submodule and its
 +	    recorded state in the superproject are taken into account.
 +
 +	untracked;; Only untracked files in submodules will be ignored.
 +	    Committed differences and modifications to tracked files will show
 +	    up.
 +
 +	none;; No modifiations to submodules are ignored, all of committed
 +	    differences, and modifications to tracked and untracked files are
 +	    shown. This is the default option.
 +
 +	If this option is also present in the submodules entry in .git/config
 +	of the superproject, the setting there will override the one found in
  	.gitmodules.
  	Both settings can be overridden on the command line by using the
  	"--ignore-submodule" option. The 'git submodule' commands are not
@@@ -93,8 -84,8 +93,8 @@@
  
  submodule.<name>.shallow::
  	When set to true, a clone of this submodule will be performed as a
- 	shallow clone unless the user explicitly asks for a non-shallow
- 	clone.
+ 	shallow clone (with a history depth of 1) unless the user explicitly
+ 	asks for a non-shallow clone.
  
  
  EXAMPLES