From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-1.mimecast.com (us-smtp-delivery-1.mimecast.com [207.211.31.81]) by mx.groups.io with SMTP id smtpd.web11.6841.1579781604284812307 for ; Thu, 23 Jan 2020 04:13:24 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@redhat.com header.s=mimecast20190719 header.b=DIfgOGkn; spf=pass (domain: redhat.com, ip: 207.211.31.81, mailfrom: lersek@redhat.com) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1579781603; h=from:from:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=vYjcaWSDXlWphsLBscYs9LIkt9vJErkb5CP2KFhQWgc=; b=DIfgOGkn3yWCx8EWQ5bonHQLDydBHm0cOwF960+CnQb1WpNafr89mHvne50EUD8U/o5x2f AFX+qeYpbzlOE4IfcfyyltLVIv5U7quZBAkdRr5xM2YUkz1H4W+zGXFSMw2eU8h+4MHL1c Tby8E09VBNMwIMdzZfz1o9ZWUThsp00= Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-187-1IE4_MiaOcmSWRGmZGfw0A-1; Thu, 23 Jan 2020 07:13:19 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 4B5951088385; Thu, 23 Jan 2020 12:13:18 +0000 (UTC) Received: from lacos-laptop-7.usersys.redhat.com (ovpn-117-226.ams2.redhat.com [10.36.117.226]) by smtp.corp.redhat.com (Postfix) with ESMTP id 3B4C010016EB; Thu, 23 Jan 2020 12:13:17 +0000 (UTC) Subject: Re: [edk2-devel] [PATCH v2] BaseTools/Conf/gitattributes: fix "--function-context" for C source code From: "Laszlo Ersek" To: edk2-devel-groups-io Cc: Bob Feng , Leif Lindholm , Liming Gao Reply-To: devel@edk2.groups.io, lersek@redhat.com References: <20200120094245.9010-1-lersek@redhat.com> Message-ID: <7ae96e2f-69f6-e001-4239-94c42424f3c6@redhat.com> Date: Thu, 23 Jan 2020 13:13:16 +0100 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.9.1 MIME-Version: 1.0 In-Reply-To: <20200120094245.9010-1-lersek@redhat.com> X-Scanned-By: MIMEDefang 2.84 on 10.5.11.22 X-MC-Unique: 1IE4_MiaOcmSWRGmZGfw0A-1 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=windows-1252 Content-Transfer-Encoding: 7bit Mike, can you please ACK this patch while Liming and Bob are away? It's very simple. Thanks! Laszlo On 01/20/20 10:42, 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 > Cc: Leif Lindholm > Cc: Liming Gao > Signed-off-by: Laszlo Ersek > --- > > Notes: > v2: > > - take suffixes from "BaseTools/Conf/build_rule.template" [Leif] > > - replace "*.h" / "*.c" in the commit message with "C source" and > [C-Code-File] / [Acpi-Table-Code-File] > > - Supersedes: <20200116184929.18020-1-lersek@redhat.com> > http://mid.mail-archive.com/20200116184929.18020-1-lersek@redhat.com > https://edk2.groups.io/g/devel/message/53312 > > BaseTools/Conf/gitattributes | 11 +++++++++++ > 1 file changed, 11 insertions(+) > > diff --git a/BaseTools/Conf/gitattributes b/BaseTools/Conf/gitattributes > index 58b93e9d4c27..319e89064133 100644 > --- a/BaseTools/Conf/gitattributes > +++ b/BaseTools/Conf/gitattributes > @@ -17,3 +17,14 @@ > *.fdf diff=ini > *.fdf.inc diff=ini > *.inf diff=ini > +*.c diff=cpp > +*.C diff=cpp > +*.cc diff=cpp > +*.CC diff=cpp > +*.cpp diff=cpp > +*.Cpp diff=cpp > +*.CPP diff=cpp > +*.aslc diff=cpp > +*.act diff=cpp > +*.h diff=cpp > +*.H diff=cpp >