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

[Christian Couder <chriscool@tuxfamily.org>]

Le mercredi 2 juillet 2008, Junio C Hamano a écrit :
>
> 	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).

>         ------------
> 	$ ... 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.