]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-submodule.txt
submodule foreach: document '$sm_path' instead of '$path'
authorPrathamesh Chavan <pc44800@gmail.com>
Wed, 9 May 2018 00:29:50 +0000 (17:29 -0700)
committerJunio C Hamano <gitster@pobox.com>
Wed, 9 May 2018 03:37:00 +0000 (12:37 +0900)
commitf0fd0dc5c5fcc066fc2e0b7dc1e809cb2d219ee3
tree3dedc761c2ba40c4c5c56271bd41fbc2137d0803
parentc033a2f62dda774de8cccc83b7f1918377995d6c
submodule foreach: document '$sm_path' instead of '$path'

As using a variable '$path' may be harmful to users due to
capitalization issues, see 64394e3ae9 (git-submodule.sh: Don't
use $path variable in eval_gettext string, 2012-04-17). Adjust
the documentation to advocate for using $sm_path,  which contains
the same value. We still make the 'path' variable available and
document it as a deprecated synonym of 'sm_path'.

Discussed-with: Ramsay Jones <ramsay@ramsayjones.plus.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-submodule.txt