Re: [PATCH v2 2/6] doc: align 'diff --no-index' in text with synopsis
From: Eric Sunshine <hidden>
Date: 2018-04-27 17:33:58
On Fri, Apr 27, 2018 at 1:04 PM, Andreas Heiduk [off-list ref] wrote:
quoted hunk ↗ jump to hunk
The two '<path>' parameters are not optional but the option '--no-index' is. Also move the `--options` part to the same place where the other variants show them. All three items are already correct in the synopsis. Signed-off-by: Andreas Heiduk <redacted> ---diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt@@ -13,7 +13,7 @@ SYNOPSIS -'git diff' [options] [--no-index] [--] <path> <path> +'git diff' [options] --no-index [--] <path> <path>@@ -29,7 +29,7 @@ two blob objects, or changes between two files on disk. -'git diff' --no-index [--options] [--] [<path>...]:: +'git diff' [--options] --no-index [--] <path> <path>::
Not a problem introduced by this patch, but shouldn't this say "[options]" rather than "[--options]"? Since the aim of this patch series is to clean up botches and normalize documentation, perhaps it could also fix this oddness(?).