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

Re: [PATCH 3/7] Documentation: complicate example of "man git-command"

From
Christian Couder <chriscool@tuxfamily.org>
Date
Jul 3, 2008, 06:06 UTC
Message-ID
<200807030806.37771.chriscool@tuxfamily.org>
In-Reply-To
<7vmyl1kvn6.fsf@gitster.siamese.dyndns.org>
Le mercredi 2 juillet 2008, Junio C Hamano a écrit :
Show 6 quoted lines
>
> 	E.g. a typical command description may go like this:
>
>         To propagate the changes you made back to the original subversion
>         repository, you would use 'git-svn dcommit' command.  It does
>         these things (long description here).  Some examples:

We might kill 2 birds with a single stone by describing "git help" instead of "git svn" (that the user may never use).

Show 10 quoted lines
>         ------------
> 	$ ... some example command sequence ...
>         $ git svn dcommit
>         ------------
>
>         For full details, type:
>
> 	------------
>         $ man git-svn
>         ------------

I saw that in another thread "git help" is also being ported to Windows and I wonder if we want the tutorial to be usable as is by people on Windows too.

I mean what if people on Windows launch "git help tutorial"? Should they see nothing or a tutorial for *nix or a special version of the tutorial for Windows or a tutorial that works everywhere? I think the latter would be best but I wonder if it is possible.

Anyway if we want to get there, perhaps we should use "git help svn" above instead of "man git-svn". (Yeah "git help help" might be confusing at first.)

Thanks, Christian.
Previous: J. Bruce FieldsNext: Junio C Hamano
Message 12 of 40 in “Some superficial documentation changes”
  1. 0/7 Some superficial documentation changesJonathan Nieder, Jun 30, 2008
  2. 1/7 Documentation: fix links to tutorials and other new manual pagesJonathan Nieder, Jun 30, 2008
  3. Christian CouderJun 30, 2008
  4. 2/7 whitespace fix in Documentation/git-repack.txtJonathan Nieder, Jun 30, 2008
  5. 3/7 Documentation: complicate example of "man git-command"Jonathan Nieder, Jun 30, 2008
  6. Christian CouderJun 30, 2008
  7. J. Bruce FieldsJul 1, 2008
  8. Junio C HamanoJul 1, 2008
  9. J. Bruce FieldsJul 2, 2008
  10. Jonathan NiederJul 3, 2008
  11. J. Bruce FieldsJul 3, 2008
  12. Christian CouderJul 3, 2008
  13. Junio C HamanoJul 3, 2008
  14. 4/7 git-daemon(1): don't assume git-daemon is in /usr/binJonathan Nieder, Jun 30, 2008
  15. 5/7 Documentation: prepare to be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  16. 6/7 Documentation: be consistent about "git-" versus "git "Jonathan Nieder, Jun 30, 2008
  17. 7/7 Documentation formatting and cleanupJonathan Nieder, Jun 30, 2008
  18. Olivier MarinJul 1, 2008
  19. Junio C HamanoJul 1, 2008
  20. Jonathan NiederJul 3, 2008
  21. Jonathan NiederJul 3, 2008
  22. Junio C HamanoJul 1, 2008
  23. Jonathan NiederJul 3, 2008
  24. 01/15 git-format-patch(1): fix stray \ in outputJonathan Nieder, Jul 3, 2008
  25. 02/15 Documentation: fix gitlinksJonathan Nieder, Jul 3, 2008
  26. 03/15 manpages: fix bogus whitespaceJonathan Nieder, Jul 3, 2008
  27. Junio C HamanoJul 3, 2008
  28. Jonathan NiederJul 4, 2008
  29. 04/15 git(1): add commaJonathan Nieder, Jul 3, 2008
  30. 05/15 git-commit(1): depersonalize descriptionJonathan Nieder, Jul 3, 2008
  31. 06/15 Documentation: rewrap to prepare for "git-" vs "git " changeJonathan Nieder, Jul 3, 2008
  32. 07/15 Documentation: more "git-" versus "git " changesJonathan Nieder, Jul 3, 2008
  33. 08/15 gitdiffcore(7): fix awkward wordingJonathan Nieder, Jul 3, 2008
  34. 09/15 manpages: italicize command names in synopsesJonathan Nieder, Jul 3, 2008
  35. 10/15 manpages: italicize command namesJonathan Nieder, Jul 3, 2008
  36. 11/15 manpages: italicize git command names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  37. 12/15 manpages: italicize gitk's name (where it was in teletype font)Jonathan Nieder, Jul 3, 2008
  38. 13/15 manpages: italicize nongit command names (if they are in teletype font)Jonathan Nieder, Jul 3, 2008
  39. 14/15 manpages: italicize git subcommand names (which were in teletype font)Jonathan Nieder, Jul 3, 2008
  40. 15/15 manpages: use teletype font for sample command linesJonathan Nieder, Jul 3, 2008

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.