public inbox for devel@edk2.groups.io
 help / color / mirror / Atom feed
* EDK II Build Comparison Tool for Uncrustify conversion
@ 2021-11-16  7:16 Michael D Kinney
  0 siblings, 0 replies; only message in thread
From: Michael D Kinney @ 2021-11-16  7:16 UTC (permalink / raw)
  To: devel@edk2.groups.io, Kinney, Michael D
  Cc: Michael Kubacki, Leif Lindholm, Andrew Fish (afish@apple.com)

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






^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-11-16  7:16 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-11-16  7:16 EDK II Build Comparison Tool for Uncrustify conversion Michael D Kinney

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox