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

Re: [PATCH 6/8] Doc/gitsubmodules: improve readability of certain lines

From
Stefan Beller <sbeller@google.com>
Date
Jan 8, 2018, 18:49 UTC
Message-ID
<CAGZ79kYPcx39VqWLAxRCQgO16=Yegq6XeCVUmX7shYomF6sz=g@mail.gmail.com>
In-Reply-To
<20180106184614.20115-7-kaartic.sivaraam@gmail.com>

On Sat, Jan 6, 2018 at 10:46 AM, Kaartic Sivaraam <kaartic.sivaraam@gmail.com> wrote:

Show 31 quoted lines
> Signed-off-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
> ---
>  Documentation/gitsubmodules.txt | 19 ++++++++++---------
>  1 file changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
> index 745a3838e..339fb73db 100644
> --- a/Documentation/gitsubmodules.txt
> +++ b/Documentation/gitsubmodules.txt
> @@ -76,9 +76,10 @@ The configuration of submodules
>  Submodule operations can be configured using the following mechanisms
>  (from highest to lowest precedence):
>
> - * The command line for those commands that support taking submodule
> -   specifications. Most commands have a boolean flag '--recurse-submodules
> -   whether to recurse into submodules. Examples are `ls-files` or `checkout`.
> + * The command line arguments of those commands that support taking submodule
> +   specifications. Most commands have a boolean flag '--recurse-submodules'
> +   which specify whether they should recurse into submodules. Examples are
> +   `ls-files` or `checkout`.
>     Some commands take enums, such as `fetch` and `push`, where you can
>     specify how submodules are affected.
>
> @@ -90,8 +91,8 @@ Submodule operations can be configured using the following mechanisms
>  For example an effect from the submodule's `.gitignore` file
>  would be observed when you run `git status --ignore-submodules=none` in
>  the superproject. This collects information from the submodule's working
> -directory by running `status` in the submodule, which does pay attention
> -to its `.gitignore` file.
> +directory by running `status` in the submodule while paying attention
> +to the `.gitignore` file of the submodule.
Both are grammatically correct and expressive, thanks!
>  +
Extra spurious line?
Show 10 quoted lines
>  The submodule's `$GIT_DIR/config` file would come into play when running
>  `git push --recurse-submodules=check` in the superproject, as this would
> @@ -107,13 +108,13 @@ If the submodule is not yet initialized, then the configuration
>  inside the submodule does not exist yet, so configuration where to
>  obtain the submodule from is configured here for example.
>
> - * the `.gitmodules` file inside the superproject. Additionally to the
> -   required mapping between submodule's name and path, a project usually
> + * The `.gitmodules` file inside the superproject. Additionally, if mapping
> +   is required between a submodule's name and its path, a project usually
This changes meaning, originally it tries to say:
* it requires mapping path <-> names.
* but there can be more.
whereas the new lines are:
* mapping is optional
* there can be more.
Show 8 quoted lines
>     uses this file to suggest defaults for the upstream collection
>     of repositories.
>  +
> -This file mainly serves as the mapping between name and path in
> -the superproject, such that the submodule's Git directory can be
> +This file mainly serves as the mapping between the name and path of submodules
> +in the superproject, such that the submodule's Git directory can be
>  located.
makes sense!

Thanks, Stefan

Show 5 quoted lines
>  +
>  If the submodule has never been initialized, this is the only place
> --
> 2.16.0.rc0.223.g4a4ac8367
>
Previous: Eric SunshineNext: Kaartic Sivaraam
Message 25 of 44 in “Doc/submodules: a few updates”
  1. 0/8 Doc/submodules: a few updatesKaartic Sivaraam, Jan 6, 2018
  2. 1/8 Doc/gitsubmodules: split a sentence for better readabilityKaartic Sivaraam, Jan 6, 2018
  3. Eric SunshineJan 7, 2018
  4. Stefan BellerJan 8, 2018
  5. 2/8 Doc/gitsubmodules: clearly specify advantage of submoduleKaartic Sivaraam, Jan 6, 2018
  6. Stefan BellerJan 8, 2018
  7. Kaartic SivaraamJan 9, 2018
  8. 3/8 Doc/gitsubmodules: specify how submodules help in reduced sizeKaartic Sivaraam, Jan 6, 2018
  9. Eric SunshineJan 7, 2018
  10. Stefan BellerJan 8, 2018
  11. Kaartic SivaraamJan 9, 2018
  12. Stefan BellerJan 9, 2018
  13. Kaartic SivaraamJan 9, 2018
  14. 4/8 Doc/gitsubmodules: avoid abbreviationsKaartic Sivaraam, Jan 6, 2018
  15. Eric SunshineJan 7, 2018
  16. Stefan BellerJan 8, 2018
  17. Kaartic SivaraamJan 9, 2018
  18. Stefan BellerJan 9, 2018
  19. Kaartic SivaraamJan 9, 2018
  20. 5/8 Doc/gitsubmodules: use "Git directory" consistentlyKaartic Sivaraam, Jan 6, 2018
  21. Eric SunshineJan 7, 2018
  22. Stefan BellerJan 8, 2018
  23. 6/8 Doc/gitsubmodules: improve readability of certain linesKaartic Sivaraam, Jan 6, 2018
  24. Eric SunshineJan 7, 2018
  25. Stefan BellerJan 8, 2018
  26. Kaartic SivaraamJan 9, 2018
  27. Stefan BellerJan 9, 2018
  28. Kaartic SivaraamJan 9, 2018
  29. 7/8 Doc/git-submodule: improve readability and grammar of a sentenceKaartic Sivaraam, Jan 6, 2018
  30. Stefan BellerJan 8, 2018
  31. 8/8 Doc/git-submodule: correctly quote important wordsKaartic Sivaraam, Jan 6, 2018
  32. Stefan BellerJan 8, 2018
  33. Kaartic SivaraamJan 9, 2018
  34. Stefan BellerJan 9, 2018
  35. 0/2 Doc/submodules: a few updatesKaartic Sivaraam, Jan 10, 2018
  36. 1/2 Doc/gitsubmodules: make some changes to improve readability and syntaxKaartic Sivaraam, Jan 10, 2018
  37. Stefan BellerJan 10, 2018
  38. 2/2 Doc/git-submodule: improve readability and grammar of a sentenceKaartic Sivaraam, Jan 10, 2018
  39. 0/2 Doc/submodules: a few updatesKaartic Sivaraam, Jan 14, 2018
  40. 1/2 Doc/gitsubmodules: make some changes to improve readability and syntaxKaartic Sivaraam, Jan 14, 2018
  41. Stefan BellerJan 16, 2018
  42. 2/2 Doc/git-submodule: improve readability and grammar of a sentenceKaartic Sivaraam, Jan 14, 2018
  43. Junio C HamanoJan 16, 2018
  44. Kaartic SivaraamJan 17, 2018

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.