Re: [PATCH] Documentation/submodule: add command references and update options
From: Junio C Hamano <hidden>
Date: 2016-06-15 22:51:39
Jens Lehmann [off-list ref] writes:
quoted hunk
@@ -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
quoted hunk
@@ -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.