{"thread":{"id":"29950","subject":"[PATCH v2] Documentation/diff-options: reword description of --submodule option","startedAt":"2012-03-14T17:00:55Z","lastAt":"2012-03-14T19:09:21Z","messageCount":2,"participants":["Tim Henigan","Junio C Hamano"],"isPatch":true,"patchVersion":2,"patchTotal":null},"messages":[{"id":"186965","messageId":"1331744455-624-1-git-send-email-tim.henigan@gmail.com","threadId":"29950","inReplyTo":null,"subject":"[PATCH v2] Documentation/diff-options: reword description of --submodule option","fromName":"Tim Henigan","fromEmail":"tim.henigan@gmail.com","sentAt":"2012-03-14T17:00:55Z","receivedAt":"2012-03-14T17:00:55Z","isPatch":true,"sender":{"key":"tim.henigan@gmail.com","avatar":"https://avatars.githubusercontent.com/u/42022?v=4"},"body":"The previous description was confusing.  This rewrite makes it easier\nto understand.\n\nSigned-off-by: Tim Henigan <tim.henigan@gmail.com>\n---\n\nChanges in v2:\n  - v1 was a series of two patches. The first was a simple typo fix\n    (s/Chose/Choose/). v2 eliminates the first commit as it is no longer\n    needed.\n  - Changed wording again based on direction from Junio Hamano.\n  - Removed explanation of formats from the commit message. The diff\n    now adequately explains how they work.\n\n\n Documentation/diff-options.txt |   11 ++++++-----\n 1 file changed, 6 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex 7d4566f..6aa0907 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -165,11 +165,12 @@ any of those replacements occurred.\n \tof the `--diff-filter` option on what the status letters mean.\n \n --submodule[=<format>]::\n-\tChose the output format for submodule differences. <format> can be one of\n-\t'short' and 'log'. 'short' just shows pairs of commit names, this format\n-\tis used when this option is not given. 'log' is the default value for this\n-\toption and lists the commits in that commit range like the 'summary'\n-\toption of linkgit:git-submodule[1] does.\n+\tSpecify how differences in submodules are shown.  When `--submodule`\n+\tor `--submodule=log` is given, the 'log' format is used.  This format lists\n+\tthe commits in the range like linkgit:git-submodule[1] `--summary` does.\n+\tOmitting the `--submodule` option or specifying `--submodule=short`,\n+\tuses the 'short' format. This format just shows the names of the commits\n+\tat the beginning and end of the range.\n \n --color[=<when>]::\n \tShow colored diff.\n-- \n1.7.10.rc0\n"},{"id":"186980","messageId":"7vzkbjov8e.fsf@alter.siamese.dyndns.org","threadId":"29950","inReplyTo":"1331744455-624-1-git-send-email-tim.henigan@gmail.com","subject":"Re: [PATCH v2] Documentation/diff-options: reword description of --submodule option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2012-03-14T19:09:21Z","receivedAt":"2012-03-14T19:09:21Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Tim Henigan <tim.henigan@gmail.com> writes:\n\n> The previous description was confusing.  This rewrite makes it easier\n> to understand.\n>\n> Signed-off-by: Tim Henigan <tim.henigan@gmail.com>\n> ---\n>\n> Changes in v2:\n>   - v1 was a series of two patches. The first was a simple typo fix\n>     (s/Chose/Choose/). v2 eliminates the first commit as it is no longer\n>     needed.\n>   - Changed wording again based on direction from Junio Hamano.\n>   - Removed explanation of formats from the commit message. The diff\n>     now adequately explains how they work.\n\nThanks for a credit, but I rarely if ever give \"direction\". I just mumble\nmy observations, and the readers realize improvements for themselves ;-)\n\nI'll squash the \"submodule summary\" (as opposed to \"submodule --summary\")\nfix Jens mentioned in the other thread and apply.\n\nThanks.\n\n>  Documentation/diff-options.txt |   11 ++++++-----\n>  1 file changed, 6 insertions(+), 5 deletions(-)\n>\n> diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\n> index 7d4566f..6aa0907 100644\n> --- a/Documentation/diff-options.txt\n> +++ b/Documentation/diff-options.txt\n> @@ -165,11 +165,12 @@ any of those replacements occurred.\n>  \tof the `--diff-filter` option on what the status letters mean.\n>  \n>  --submodule[=<format>]::\n> -\tChose the output format for submodule differences. <format> can be one of\n> -\t'short' and 'log'. 'short' just shows pairs of commit names, this format\n> -\tis used when this option is not given. 'log' is the default value for this\n> -\toption and lists the commits in that commit range like the 'summary'\n> -\toption of linkgit:git-submodule[1] does.\n> +\tSpecify how differences in submodules are shown.  When `--submodule`\n> +\tor `--submodule=log` is given, the 'log' format is used.  This format lists\n> +\tthe commits in the range like linkgit:git-submodule[1] `--summary` does.\n> +\tOmitting the `--submodule` option or specifying `--submodule=short`,\n> +\tuses the 'short' format. This format just shows the names of the commits\n> +\tat the beginning and end of the range.\n>  \n>  --color[=<when>]::\n>  \tShow colored diff.\n"}]}