Docs: Add some missing options to git-diff.txt
PATCH 1/1 Docs: Add some missing options to git-diff.txt
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.
--- Documentation/git-diff.txt | 8 ++++++++ 1 file changed, 8 insertions(+)
Documentation/git-diff.txt +8 -0
@@ -97,6 +97,14 @@ OPTIONS :git-diff: 1 include::diff-options.txt[] +-1 --base:: +-2 --ours:: +-3 --theirs:: +-0:: + Diff against the "base" version, "our branch" or "their + branch" respectively. The option -0 can be given to omit diff + output for unmerged entries and just show "Unmerged". + <path>...:: The <paths> parameters, when given, are used to limit the diff to the named paths (you can give directory
Signature · 1 line
2.7.4
Quoted 3 lines · Andreas Heiduk
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.
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.
PATCH v2 1/1 Docs: Add some missing options to git-diff.txt
New attempt due to whitespace fixes after EndOfSenctence.
Quoted 8 lines · Junio C Hamano
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.
--- Documentation/git-diff.txt | 14 ++++++++++++++ 1 file changed, 14 insertions(+)
Documentation/git-diff.txt +14 -0
@@ -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
Signature · 1 line
2.12.2
PATCH 1/1 Docs: Add some missing options to git-diff.txt
In reply to Andreas HeidukWell, 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.
--- Documentation/git-diff.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+)
Documentation/git-diff.txt +15 -0
@@ -97,6 +97,21 @@ 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 more 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
Signature · 1 line
2.12.2