[PATCH v2] Docs: Add some missing options to git-diff.txt
- From
Andreas Heiduk <asheiduk@gmail.com>
- Date
- Apr 11, 2017, 14:39 UTC
- Message-ID
- <20170411143950.31207-1-asheiduk@gmail.com>
- In-Reply-To
- <xmqqinmq34d3.fsf@gitster.mtv.corp.google.com>
New attempt due to whitespace fixes after EndOfSenctence.
Junio C Hamano writes:
Show 8 quoted lines
> This is probably a shared issue with the original text for > "diff-files", but I think we must stress that these options make > sense only when you are in the middle of conflict resolution. > > In addition, unlike "diff-files", if these were to appear in the > general "git diff" documentation, it also must stress that these > options are only about comparing the index and the working tree > files, e.g. "git diff --ours HEAD^ HEAD" does not make sense.
Well, this wording picks up your points but I won't call it "stress it" :-) However this should do the job.
------- 8< -------------------------- >8 ------------- git-diff understands "--ours", "--theirs" and "--base" for files with conflicts. But so far they were not documented for the central diff command but only for diff-files.
Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> --- Documentation/git-diff.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt index bbab35fca..b0c1bb95c 100644 --- a/Documentation/git-diff.txt +++ b/Documentation/git-diff.txt @@ -97,6 +97,20 @@ OPTIONS :git-diff: 1 include::diff-options.txt[] +-1 --base:: +-2 --ours:: +-3 --theirs:: + Compare the working tree with the "base" version (stage #1), + "our branch" (stage #2) or "their branch" (stage #3). The + index contains these stages only for unmerged entries i.e. + while resolving conflicts. See linkgit:git-read-tree[1] + section "3-Way Merge" for detailed information. + +-0:: + Omit diff output for unmerged entries and just show + "Unmerged". Can be used only when comparing the working tree + with the index. + <path>...:: The <paths> parameters, when given, are used to limit the diff to the named paths (you can give directory
-- 2.12.2