[PATCH] Fix diff-options references in git-diff and git-format-patch
From: Brian Gernhardt <hidden>
Date: 2016-06-15 22:42:58
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Most of the git-diff-* documentation used [<common diff options>] instead of [--diff-options], so make that change in git-diff and git-format-patch. In addition, git-format-patch didn't include the meanings of the diff options. Signed-off-by: Brian Gernhardt <redacted> --- On Mar 5, 2007, at 6:14 PM, Johannes Schindelin wrote:
Actually, it is described briefly in the synopsis. But not in the options section. Care to provide a patch (see git-log.txt for an example how to include the diff options)?
Something like this? Documentation/git-diff.txt | 2 +- Documentation/git-format-patch.txt | 6 ++++-- 2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 12a531d..044cee9 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt@@ -8,7 +8,7 @@ git-diff - Show changes between commits, commit and working tree, etc SYNOPSIS -------- -'git-diff' [ --diff-options ] <commit>{0,2} [--] [<path>...] +'git-diff' [<common diff options>] <commit>{0,2} [--] [<path>...] DESCRIPTION -----------
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 59f34b9..84eabeb 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt@@ -9,8 +9,8 @@ git-format-patch - Prepare patches for e-mail submission SYNOPSIS -------- [verse] -'git-format-patch' [-n | -k] [-o <dir> | --stdout] [--attach] [--thread] - [-s | --signoff] [--diff-options] [--start-number <n>] +'git-format-patch' [<common diff options>] [-n | -k] [-o <dir> | --stdout] + [--attach] [--thread] [-s | --signoff] [--start-number <n>] [--in-reply-to=Message-Id] [--suffix=.<sfx>] [--ignore-if-in-upstream] <since>[..<until>]
@@ -46,6 +46,8 @@ reference. OPTIONS ------- +include::diff-options.txt[] + -o|--output-directory <dir>:: Use <dir> to store the resulting files, instead of the current working directory.
--
1.5.0.3.271.g5ced