On 01/20/20 11:12, Leif Lindholm wrote:
> On Mon, Jan 20, 2020 at 10:42:45 +0100, Laszlo Ersek wrote:
>> The "--function-context" ("-W") option of git-diff displays the entire
>> body of a modified function, not just small modified hunks within the
>> function. It is useful for reviewers when the code changes to the function
>> are small, but they could affect, or depend on, control flow that is far
>> away in the same function.
>>
>> Of course, the size of the displayed context can be controlled with the
>> "-U" option anyway, but such fixed-size contexts are usually either too
>> small, or too large, in the above scenario.
>>
>> It turns out that "--function-context" does not work correctly for C
>> source files in edk2. In particular, labels for the goto instruction
>> (which the edk2 coding style places in the leftmost column) appear to
>> terminate "--function-context".
>>
>> The "git" utility contains built-in hunk header patterns for the C and C++
>> languages. However, they do not take effect in edk2 because we don't
>> explicitly assign the "cpp" git-diff driver to our C files. The
>> gitattributes(5) manual explains that this is required:
>>
>>> There are a few built-in patterns to make this easier, and
>>> tex is one of them, so you do not have to write the above in
>>> your configuration file (you still need to enable this with
>>> the attribute mechanism, via .gitattributes). The following
>>> built in patterns are available:
>>>
>>> [...]
>>>
>>> * cpp suitable for source code in the C and C++
>>> languages.
>>
>> The key statement is the one in parentheses.
>>
>> Grab the suffix lists from the [C-Code-File] and [Acpi-Table-Code-File]
>> sections of "BaseTools/Conf/build_rule.template", add "*.h" and "*.H", and
>> mark those as belonging to the "cpp" git-diff driver.
>>
>> This change has a dramatic effect on the following command, for example:
>>
>> $ git show -W 2ef0c27cb84c
>>
>> Cc: Bob Feng <bob.c.f...@intel.com>
>> Cc: Leif Lindholm <leif.lindh...@linaro.org>
>> Cc: Liming Gao <liming....@intel.com>
>> Signed-off-by: Laszlo Ersek <ler...@redhat.com>
>
> Reviewed-by: Leif Lindholm <l...@nuviainc.com>
Thanks!
> also
> Reviewed-by: Leif Lindholm <leif.lindh...@linaro.org>
> (if it jars too much to use a different one from Cc: tag above)
>
> For other purposes, the Linaro address can now be considered retired.
Ah yes, sorry about not updating the CC tag with the v1->v2 rebase!
(Because, I had updated even my text editor shortcut that inserts your
name+email!)
Thanks!
Laszlo
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#53415): https://edk2.groups.io/g/devel/message/53415
Mute This Topic: https://groups.io/mt/69928741/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-
