This series aims at improving the output of 'git range-diff',
especially in cases like the one mentioned in [*1*], where a diff
header, that was before the outer diff's hunk header was
misinterpreted as being the filename of the diff that followed it.
It does so by substituting the diff header of the inner diff with a
range-diff specific "section header", which is then parsed by a
userdiff pattern, so it's included in the outer diff's hunk header.
Additionally, instead of stripping out the whole hunk header of the
inner diff, and replacing it by just an "@@", only strip the line
numbers from that hunk header, but keep the funcname/xfuncname.
This information is not added to the outer diff's hunk header, because
it feels like that would end up in too much information, and I feel
like the filename is the more useful bit of information if we have to
pick one of them.
As an example, here's what the relevant part of the range-diff from
the original thread would look like now:
@@ -99,10 +90,10 @@ modified file Documentation/git-revert.txt
-should see linkgit:git-checkout[1], specifically the `git checkout
-<commit> -- <filename>` syntax. Take care with these alternatives as
+should see linkgit:git-restore[1], specifically the `--source`
-+option Take care with these alternatives as
++option. Take care with these alternatives as
both will discard uncommitted changes in your working directory.
- OPTIONS
+ See "Reset, restore and revert" in linkgit:git[1] for the differences
@@ -129,10 +120,11 @@ modified file Documentation/giteveryday.txt
* linkgit:git-commit[1] to advance the current branch.
- * linkgit:git-reset[1] and linkgit:git-checkout[1] (with
-+ * linkgit:git-reset[1] and linkgit:git-restore[1] (with
- pathname parameters) to undo changes.
+- pathname parameters) to undo changes.
++ * linkgit:git-restore[1] to undo changes.
* linkgit:git-merge[1] to merge between local branches.
+
@@ Create a topic branch and develop.::
------------
$ git switch -c alsa-audio <1>
Note that this patch series doesn't modify or add any tests, and was
just manually tested locally, thus it is still marked as RFC. I'd
love to get some feedback on the output format first, before touching
any tests, as I expect there might be some discussion on the final
format.
*1*: <20190411111729.GB5620@ash>
This series can also be fetched from
https://github.com/tgummerer/git tg/range-diff-output
Thomas Gummerer (4):
range-diff: fix function parameter indentation
range-diff: don't remove funcname from inner diff
range-diff: add section header instead of diff header
range-diff: add section headers to the outer hunk header
range-diff.c | 55 ++++++++++++++++++++++++++++++++++++++++++----------
1 file changed, 45 insertions(+), 10 deletions(-)
--
2.21.0.593.g511ec345e1
