public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
From: "Michael D Kinney" <michael.d.kinney@intel.com>
To: "devel@edk2.groups.io" <devel@edk2.groups.io>,
	"Kinney, Michael D" <michael.d.kinney@intel.com>
Cc: Michael Kubacki <Michael.Kubacki@microsoft.com>,
	Leif Lindholm <leif@nuviainc.com>,
	"Andrew Fish (afish@apple.com)" <afish@apple.com>
Subject: EDK II Build Comparison Tool for Uncrustify conversion
Date: Tue, 16 Nov 2021 07:16:41 +0000	[thread overview]
Message-ID: <CO1PR11MB492910AFD40FCB886B21F957D2999@CO1PR11MB4929.namprd11.prod.outlook.com> (raw)

Hello,

As part of the uncrustify work, I have implemented a build comparison tool that
can be used to verify that source code style changes have no impact to any of the
generated binary files.

A full description of the CompareBuild.py tool and the GitHub Action to compare
all packages/platform builds in an edk2 repository can be found in following branch.

    https://github.com/mdkinney/edk2/tree/sandbox/CompareBuild

I have prepared a full conversion of the edk2 using uncrustify in the following
2 branches.  You can pull these branches and compare them to see what uncrustify 
has done.

    https://github.com/mdkinney/edk2/tree/sandbox/uncrustify_before_V3
    https://github.com/mdkinney/edk2/tree/sandbox/uncrustify_after_V3

I have also run the GitHub Action that compares all the package/platform builds
in an edk2 repo against these 2 branches.  A total of 70 edk2 builds are run and
their build output directories are compared and show the builds are nearly
identical.  Only the WinHost module in the EmulatorPkg shows a difference.

    https://github.com/mdkinney/edk2/actions/runs/1460837630

A small change to WinHost.inf can resolve this difference.

    https://github.com/mdkinney/edk2/commit/15e22c4c55a738047cbaba612fa01f534cb43b97

I have applied this one change to WinHost.inf to the following branches:

    https://github.com/mdkinney/edk2/tree/sandbox/uncrustify_before_V3_WinHostFix
    https://github.com/mdkinney/edk2/tree/sandbox/uncrustify_after_V3_WinHostFix

The GitHub Action of the 70 build comparisons passes:

    https://github.com/mdkinney/edk2/actions/runs/1460961927

This build comparison tool will be used to do the final verification before
the uncrustify pull request is approved.

Please provide feedback on the source style in the branches and feedback on
the build comparison tool.

Thanks,

Mike






                 reply	other threads:[~2021-11-16  7:16 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-list from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=CO1PR11MB492910AFD40FCB886B21F957D2999@CO1PR11MB4929.namprd11.prod.outlook.com \
    --to=devel@edk2.groups.io \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox