git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* [PATCH] submodule foreach: replace $path with $sm_path in example
@ 2020-01-31 17:08 Kyle Meyer
  2020-01-31 20:57 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Kyle Meyer @ 2020-01-31 17:08 UTC (permalink / raw)
  To: git; +Cc: Kyle Meyer

f0fd0dc5c5 (submodule foreach: document '$sm_path' instead of '$path',
2018-05-08) updated the documentation to advise callers to favor
$sm_path over the deprecated synonym $path.  However, the example in
that section still uses $path.  Update it to use $sm_path.

Signed-off-by: Kyle Meyer <kyle@kyleam.com>
---
 Documentation/git-submodule.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 5232407f68..218942acd1 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -229,7 +229,7 @@ As an example, the command below will show the path and currently
 checked out commit for each submodule:
 +
 --------------
-git submodule foreach 'echo $path `git rev-parse HEAD`'
+git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
 --------------
 
 sync [--recursive] [--] [<path>...]::
-- 
2.25.0


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] submodule foreach: replace $path with $sm_path in example
  2020-01-31 17:08 [PATCH] submodule foreach: replace $path with $sm_path in example Kyle Meyer
@ 2020-01-31 20:57 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2020-01-31 20:57 UTC (permalink / raw)
  To: Kyle Meyer; +Cc: git

Kyle Meyer <kyle@kyleam.com> writes:

> f0fd0dc5c5 (submodule foreach: document '$sm_path' instead of '$path',
> 2018-05-08) updated the documentation to advise callers to favor
> $sm_path over the deprecated synonym $path.  However, the example in
> that section still uses $path.  Update it to use $sm_path.
>
> Signed-off-by: Kyle Meyer <kyle@kyleam.com>

Makes sense.  Thanks for a careful reading.  Will apply.

> ---
>  Documentation/git-submodule.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index 5232407f68..218942acd1 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -229,7 +229,7 @@ As an example, the command below will show the path and currently
>  checked out commit for each submodule:
>  +
>  --------------
> -git submodule foreach 'echo $path `git rev-parse HEAD`'
> +git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
>  --------------
>  
>  sync [--recursive] [--] [<path>...]::

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2020-01-31 20:57 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-31 17:08 [PATCH] submodule foreach: replace $path with $sm_path in example Kyle Meyer
2020-01-31 20:57 ` Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).