git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [GSoC][PATCH 12/13] submodule foreach: document variable '$displaypath'

From
BWBrandon Williams <bmwill@google.com>
Date
Jul 25, 2017, 00:16 UTC
Message-ID
<20170725001656.GH92874@google.com>
In-Reply-To
<20170724203454.13947-13-pc44800@gmail.com>
On 07/25, Prathamesh Chavan wrote:
> It was observer that the variable '$displaypath' was accessible but
s/observer/observed 
Show 90 quoted lines
> undocumented. Hence, document it.
> 
> Discussed-with: Ramsay Jones <ramsay@ramsayjones.plus.com>
> Signed-off-by: Stefan Beller <sbeller@google.com>
> Signed-off-by: Prathamesh Chavan <pc44800@gmail.com>
> ---
>  Documentation/git-submodule.txt |  6 ++++--
>  t/t7407-submodule-foreach.sh    | 22 +++++++++++-----------
>  2 files changed, 15 insertions(+), 13 deletions(-)
> 
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index 8e7930ebc..0cca702cb 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -183,10 +183,12 @@ information too.
>  
>  foreach [--recursive] <command>::
>  	Evaluates an arbitrary shell command in each checked out submodule.
> -	The command has access to the variables $name, $sm_path, $sha1 and
> -	$toplevel:
> +	The command has access to the variables $name, $sm_path, $displaypath,
> +	$sha1 and $toplevel:
>  	$name is the name of the relevant submodule section in `.gitmodules`,
>  	$sm_path is the path of the submodule as recorded in the superproject,
> +	$displaypath contains the relative path from the current working
> +	directory to the submodules root directory,
>  	$sha1 is the commit as recorded in the superproject, and
>  	$toplevel is the absolute path to its superproject, such that
>  	$toplevel/$sm_path is the absolute path of the submodule.
> diff --git a/t/t7407-submodule-foreach.sh b/t/t7407-submodule-foreach.sh
> index 0663622a4..6ad57e061 100755
> --- a/t/t7407-submodule-foreach.sh
> +++ b/t/t7407-submodule-foreach.sh
> @@ -82,16 +82,16 @@ test_expect_success 'test basic "submodule foreach" usage' '
>  
>  cat >expect <<EOF
>  Entering '../sub1'
> -$pwd/clone-foo1-sub1-$sub1sha1
> +$pwd/clone-foo1-sub1-../sub1-$sub1sha1
>  Entering '../sub3'
> -$pwd/clone-foo3-sub3-$sub3sha1
> +$pwd/clone-foo3-sub3-../sub3-$sub3sha1
>  EOF
>  
>  test_expect_success 'test "submodule foreach" from subdirectory' '
>  	mkdir clone/sub &&
>  	(
>  		cd clone/sub &&
> -		git submodule foreach "echo \$toplevel-\$name-\$sm_path-\$sha1" >../../actual
> +		git submodule foreach "echo \$toplevel-\$name-\$sm_path-\$displaypath-\$sha1" >../../actual
>  	) &&
>  	test_i18ncmp expect actual
>  '
> @@ -206,25 +206,25 @@ submodulesha1=$(cd clone2/nested1/nested2/nested3/submodule && git rev-parse HEA
>  
>  cat >expect <<EOF
>  Entering '../nested1'
> -$pwd/clone2-nested1-nested1-$nested1sha1
> +$pwd/clone2-nested1-nested1-../nested1-$nested1sha1
>  Entering '../nested1/nested2'
> -$pwd/clone2/nested1-nested2-nested2-$nested2sha1
> +$pwd/clone2/nested1-nested2-nested2-../nested1/nested2-$nested2sha1
>  Entering '../nested1/nested2/nested3'
> -$pwd/clone2/nested1/nested2-nested3-nested3-$nested3sha1
> +$pwd/clone2/nested1/nested2-nested3-nested3-../nested1/nested2/nested3-$nested3sha1
>  Entering '../nested1/nested2/nested3/submodule'
> -$pwd/clone2/nested1/nested2/nested3-submodule-submodule-$submodulesha1
> +$pwd/clone2/nested1/nested2/nested3-submodule-submodule-../nested1/nested2/nested3/submodule-$submodulesha1
>  Entering '../sub1'
> -$pwd/clone2-foo1-sub1-$sub1sha1
> +$pwd/clone2-foo1-sub1-../sub1-$sub1sha1
>  Entering '../sub2'
> -$pwd/clone2-foo2-sub2-$sub2sha1
> +$pwd/clone2-foo2-sub2-../sub2-$sub2sha1
>  Entering '../sub3'
> -$pwd/clone2-foo3-sub3-$sub3sha1
> +$pwd/clone2-foo3-sub3-../sub3-$sub3sha1
>  EOF
>  
>  test_expect_success 'test "submodule foreach --recursive" from subdirectory' '
>  	(
>  		cd clone2/untracked &&
> -		git submodule foreach --recursive "echo \$toplevel-\$name-\$sm_path-\$sha1" >../../actual
> +		git submodule foreach --recursive "echo \$toplevel-\$name-\$sm_path-\$displaypath-\$sha1" >../../actual
>  	) &&
>  	test_i18ncmp expect actual
>  '
> -- 
> 2.13.0
> 
-- 
Brandon Williams
Previous: Prathamesh ChavanNext: Prathamesh Chavan
Message 21 of 41 in “Update: Week 10”
  1. Prathamesh ChavanJul 24, 2017
  2. [GSoC][PATCH 01/13] submodule--helper: introduce get_submodule_displaypath()Prathamesh Chavan, Jul 24, 2017
  3. [GSoC][PATCH 02/13] submodule--helper: introduce for_each_submodule_list()Prathamesh Chavan, Jul 24, 2017
  4. [GSoC][PATCH 03/13] submodule: port set_name_rev() from shell to CPrathamesh Chavan, Jul 24, 2017
  5. Brandon WilliamsJul 24, 2017
  6. [GSoC][PATCH 04/13] submodule: port submodule subcommand 'status' from shell to CPrathamesh Chavan, Jul 24, 2017
  7. Brandon WilliamsJul 24, 2017
  8. [GSoC][PATCH 05/13] submodule: port submodule subcommand 'sync' from shell to CPrathamesh Chavan, Jul 24, 2017
  9. Brandon WilliamsJul 24, 2017
  10. [GSoC][PATCH 06/13] submodule: port submodule subcommand 'deinit' from shell to CPrathamesh Chavan, Jul 24, 2017
  11. Brandon WilliamsJul 24, 2017
  12. [GSoC][PATCH 07/13] diff: change scope of the function count_lines()Prathamesh Chavan, Jul 24, 2017
  13. [GSoC][PATCH 08/13] submodule: port submodule subcommand 'summary' from shell to CPrathamesh Chavan, Jul 24, 2017
  14. Brandon WilliamsJul 25, 2017
  15. [GSoC][PATCH 09/13] submodule foreach: correct '$path' in nested submodules from a subdirectoryPrathamesh Chavan, Jul 24, 2017
  16. Brandon WilliamsJul 25, 2017
  17. [GSoC][PATCH 10/13] submodule foreach: document '$sm_path' instead of '$path'Prathamesh Chavan, Jul 24, 2017
  18. Brandon WilliamsJul 25, 2017
  19. [GSoC][PATCH 11/13] submodule foreach: clarify the '$toplevel' variable documentationPrathamesh Chavan, Jul 24, 2017
  20. [GSoC][PATCH 12/13] submodule foreach: document variable '$displaypath'Prathamesh Chavan, Jul 24, 2017
  21. Brandon WilliamsJul 25, 2017
  22. [GSoC][PATCH 13/13] submodule: port submodule subcommand 'foreach' from shell to CPrathamesh Chavan, Jul 24, 2017
  23. Brandon WilliamsJul 25, 2017
  24. [GSoC][PATCH v2 00/13] Update: Week 10Prathamesh Chavan, Jul 29, 2017
  25. [GSoC][PATCH v2 01/13] submodule--helper: introduce get_submodule_displaypath()Prathamesh Chavan, Jul 29, 2017
  26. [GSoC][PATCH v2 02/13] submodule--helper: introduce for_each_submodule_list()Prathamesh Chavan, Jul 29, 2017
  27. [GSoC][PATCH v2 03/13] submodule: port set_name_rev() from shell to CPrathamesh Chavan, Jul 29, 2017
  28. [GSoC][PATCH v2 04/13] submodule: port submodule subcommand 'status' from shell to CPrathamesh Chavan, Jul 29, 2017
  29. Christian CouderJul 30, 2017
  30. [GSoC][PATCH v2 05/13] submodule: port submodule subcommand 'sync' from shell to CPrathamesh Chavan, Jul 29, 2017
  31. [GSoC][PATCH v2 06/13] submodule: port submodule subcommand 'deinit' from shell to CPrathamesh Chavan, Jul 29, 2017
  32. [GSoC][PATCH v2 07/13] diff: change scope of the function count_lines()Prathamesh Chavan, Jul 29, 2017
  33. [GSoC][PATCH v2 08/13] submodule: port submodule subcommand 'summary' from shell to CPrathamesh Chavan, Jul 29, 2017
  34. Christian CouderJul 30, 2017
  35. Prathamesh ChavanJul 30, 2017
  36. [GSoC][PATCH v2 09/13] submodule foreach: correct '$path' in nested submodules from a subdirectoryPrathamesh Chavan, Jul 29, 2017
  37. [GSoC][PATCH v2 10/13] submodule foreach: document '$sm_path' instead of '$path'Prathamesh Chavan, Jul 29, 2017
  38. [GSoC][PATCH v2 11/13] submodule foreach: clarify the '$toplevel' variable documentationPrathamesh Chavan, Jul 29, 2017
  39. [GSoC][PATCH v2 12/13] submodule foreach: document variable '$displaypath'Prathamesh Chavan, Jul 29, 2017
  40. [GSoC][PATCH v2 13/13] submodule: port submodule subcommand 'foreach' from shell to CPrathamesh Chavan, Jul 29, 2017
  41. Brandon WilliamsJul 31, 2017

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.