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

Re: [PATCH] submodule documentation: Reorder introductory paragraphs

From
Heiko Voigt <hvoigt@hvoigt.net>
Date
May 21, 2015, 13:04 UTC
Message-ID
<20150521130429.GB22553@book.hvoigt.net>
In-Reply-To
<1432163517-22785-1-git-send-email-sbeller@google.com>
On Wed, May 20, 2015 at 04:11:57PM -0700, Stefan Beller wrote:
Show 21 quoted lines
> It's better to start the man page with a description of what submodules
> actually are instead of saying what they are not.
> 
> Reorder the paragraphs such that
> the first short paragraph introduces the submodule concept,
> the second paragraph highlights the usage of the submodule command,
> the third paragraph giving background information,
> and finally the fourth paragraph discusing alternatives such
> as subtrees and remotes, which we don't want to be confused with.
> 
> This ordering deepens the knowledge on submodules with each paragraph.
> First the basic questions like "How/what" will be answered, while the
> underlying concepts will be taught at a later time.
> 
> Making sure it is not confused with subtrees and remotes is not really
> enhancing knowledge of submodules itself, but rather painting the big
> picture of git concepts, so you could also argue to have it as the second
> paragraph. Personally I think this may confuse readers, specially newcomers
> though.
> 
> Signed-off-by: Stefan Beller <sbeller@google.com>
Looks good to me.
Cheers Heiko
Previous: Stefan BellerNext: Junio C Hamano
Message 2 of 13 in “submodule documentation: Reorder introductory paragraphs”
  1. submodule documentation: Reorder introductory paragraphsStefan Beller, May 20, 2015
  2. Heiko VoigtMay 21, 2015
  3. Junio C HamanoMay 21, 2015
  4. Stefan BellerMay 21, 2015
  5. Philip OakleyMay 21, 2015
  6. Stefan BellerMay 21, 2015
  7. Philip OakleyMay 22, 2015
  8. Junio C HamanoMay 22, 2015
  9. Stefan BellerMay 22, 2015
  10. Junio C HamanoMay 22, 2015
  11. Philip OakleyMay 22, 2015
  12. Stefan BellerMay 22, 2015
  13. Philip OakleyMay 22, 2015

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.