submodule foreach: replace $path with $sm_path in example
diff mbox series

Message ID 20200131170843.11130-1-kyle@kyleam.com
State New
Headers show
Series
  • submodule foreach: replace $path with $sm_path in example
Related show

Commit Message

Kyle Meyer Jan. 31, 2020, 5:08 p.m. UTC
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(-)

Comments

Junio C Hamano Jan. 31, 2020, 8:57 p.m. UTC | #1
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>...]::

Patch
diff mbox series

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>...]::