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

Re: [PATCH/RFC] Cleanup Documentation

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 19, 2017, 05:24 UTC
Message-ID
<xmqq1sqgv9ax.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<20170619030518.6712-1-kaarticsivaraam91196@gmail.com>

Stefan, this was sent in my way, but I know you are the primary person who is looking into updating submodule documentation these days, so I am forwarding it in your way to ask you to give the first comment.

Thanks.
Kaartic Sivaraam <kaarticsivaraam91196@gmail.com> writes:
Show 72 quoted lines
> 1. Remove redundancy from documentation
> 2. Remove unclear reference to alternative
>
> Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
> ---
>
> The following line seemes unclear and hence was removed for now. Suggest any
> changes that could make it clear.
>
> "This second form is provided to ease creating a new submodule from scratch, 
> and presumes the user will later push the submodule to the given URL."
>
>
>  Documentation/git-submodule.txt | 37 ++++++++++++++++---------------------
>  1 file changed, 16 insertions(+), 21 deletions(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index 74bc6200d..9812b0655 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -63,13 +63,7 @@ add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--dep
>  	to the changeset to be committed next to the current
>  	project: the current project is termed the "superproject".
>  +
> -This requires at least one argument: <repository>. The optional
> -argument <path> is the relative location for the cloned submodule
> -to exist in the superproject. If <path> is not given, the
> -"humanish" part of the source repository is used ("repo" for
> -"/path/to/repo.git" and "foo" for "host.xz:foo/.git").
> -The <path> is also used as the submodule's logical name in its
> -configuration entries unless `--name` is used to specify a logical name.
> +This requires at least one argument: <repository>.
>  +
>  <repository> is the URL of the new submodule's origin repository.
>  This may be either an absolute URL, or (if it begins with ./
> @@ -87,21 +81,22 @@ If the superproject doesn't have a default remote configured
>  the superproject is its own authoritative upstream and the current
>  working directory is used instead.
>  +
> -<path> is the relative location for the cloned submodule to
> -exist in the superproject. If <path> does not exist, then the
> -submodule is created by cloning from the named URL. If <path> does
> -exist and is already a valid Git repository, then this is added
> -to the changeset without cloning. This second form is provided
> -to ease creating a new submodule from scratch, and presumes
> -the user will later push the submodule to the given URL.
> +The optional argument <path> is the relative location for the cloned
> +submodule to exist in the superproject. If <path> is not given, the
> +"humanish" part of the source repository is used ("repo" for
> +"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If <path>
> +exists and is already a valid Git repository, then this is added
> +to the changeset without cloning. The <path> is also used as the
> +submodule's logical name in its configuration entries unless `--name`
> +is used to specify a logical name.
>  +
> -In either case, the given URL is recorded into .gitmodules for
> -use by subsequent users cloning the superproject. If the URL is
> -given relative to the superproject's repository, the presumption
> -is the superproject and submodule repositories will be kept
> -together in the same relative location, and only the
> -superproject's URL needs to be provided: git-submodule will correctly
> -locate the submodule using the relative URL in .gitmodules.
> +The given URL is recorded into .gitmodules for use by subsequent users
> +cloning the superproject. If the URL is given relative to the
> +superproject's repository, the presumption is the superproject and
> +submodule repositories will be kept together in the same relative
> +location, and only the superproject's URL needs to be provided.
> +git-submodule will correctly locate the submodule using the relative
> +URL in .gitmodules.
>  
>  status [--cached] [--recursive] [--] [<path>...]::
>  	Show the status of the submodules. This will print the SHA-1 of the
Previous: Kaartic SivaraamNext: Stefan Beller
Message 2 of 15 in “Cleanup Documentation”
  1. Cleanup DocumentationKaartic Sivaraam, Jun 19, 2017
  2. Junio C HamanoJun 19, 2017
  3. Stefan BellerJun 19, 2017
  4. Kaartic SivaraamJun 19, 2017
  5. Stefan BellerJun 19, 2017
  6. Cleanup DocumentationKaartic Sivaraam, Jun 20, 2017
  7. Stefan BellerJun 20, 2017
  8. Stefan BellerJun 20, 2017
  9. Documentation/git-submodule: cleanupKaartic Sivaraam, Jun 21, 2017
  10. Junio C HamanoJun 21, 2017
  11. Kaartic SivaraamJun 21, 2017
  12. Documentation/git-submodule: cleanupKaartic Sivaraam, Jun 22, 2017
  13. Junio C HamanoJun 22, 2017
  14. Stefan BellerJun 22, 2017
  15. Kaartic SivaraamJun 20, 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.