Re: [PATCH] Documentation/submodule: add command references and update options

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 25, 2011, 20:30 UTC
Message-ID: <7vmxg2qf0j.fsf@alter.siamese.dyndns.org>
In-Reply-To: <4E2B1A54.2000605@web.de>

Jens Lehmann <Jens.Lehmann@web.de> writes:

Show 6 quoted lines

> @@ -131,7 +137,7 @@ update::
>  +
>  If the submodule is not yet initialized, and you just want to use the
>  setting as stored in .gitmodules, you can automatically initialize the
> -submodule with the --init option.
> +submodule with the '--init' option.

Don't we want to use

	the `--init` option

instead for consistency? After all, that is what the users actually type.

	$ git grep -e "\`--[a-z]" Documentation/ | wc -l
        287
        $ git grep -e "'--[a-z]" Documentation/ | wc -l
        132

Show 15 quoted lines

> @@ -140,11 +146,14 @@ summary::
>  	Show commit summary between the given commit (defaults to HEAD) and
>  	working tree/index. For a submodule in question, a series of commits
>  	in the submodule between the given super project commit and the
> -	index or working tree (switched by --cached) are shown. If the option
> -	--files is given, show the series of commits in the submodule between
> +	index or working tree (switched by '--cached') are shown. If the option
> +	'--files' is given, show the series of commits in the submodule between
>  	the index of the super project and the working tree of the submodule
> -	(this option doesn't allow to use the --cached option or to provide an
> +	(this option doesn't allow to use the '--cached' option or to provide an
>  	explicit commit).
> ++
> +Using the '--submodule=log' option with linkgit:git-diff[1] will provide the
> +same information.

I am not a huge fan of these extra paragraphs, especially in reality it is not "provide the same" but "the same and a lot of other".

I dunno.