Code

userdiff/perl: anchor "sub" and "package" patterns on the left
authorJonathan Nieder <jrnieder@gmail.com>
Sat, 21 May 2011 19:29:01 +0000 (14:29 -0500)
committerJunio C Hamano <gitster@pobox.com>
Sun, 22 May 2011 05:29:31 +0000 (22:29 -0700)
commitf12c66b9bb851aa7350d40370e6adf78535c5930
tree11466c75ff5f6d7f341ed5bbd00f9fe82a6b1293
parentd64d6cdc2071d1eb7f6a45118edc42627e6fc692
userdiff/perl: anchor "sub" and "package" patterns on the left

The userdiff funcname mechanism has no concept of nested scopes ---
instead, "git diff" and "git grep --show-function" simply label the
diff header with the most recent matching line.  Unfortunately that
means text following a subroutine in a POD section:

=head1 DESCRIPTION

You might use this facility like so:

sub example {
foo;
}

Now, having said that, let's say more about the facility.
Blah blah blah ... etc etc.

gets the subroutine name instead of the POD header in its diff/grep
funcname header, making it harder to get oriented when reading a
diff without enough context.

The fix is simple: anchor the funcname syntax to the left margin so
nested subroutines and packages like this won't get picked up.  (The
builtin C++ funcname pattern already does the same thing.)  This means
the userdiff driver will misparse the idiom

{
my $static;
sub foo {
... use $static ...
}
}

but I think that's worth it; we can revisit this later if the userdiff
mechanism learns to keep track of the beginning and end of nested
scopes.

Reported-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
t/t4018-diff-funcname.sh
userdiff.c