Re: [edk2-devel] EDK2 CI build error "Uncrustify Coding Standard"

["Michael D Kinney" <michael.d.kinney@intel.com>]

Hi Brijesh,

Yes.  Your branch can be rebased on top of edk2/master after uncrustify changes.

You have added new c/h files, so those files need to be run through uncrustify locally and 
your patch updated with those formatting changes.

The following command updates every c/h file except BaseTools locally.

    git ls-files *.c *.h :!BaseTools/* | .pytool\Plugin\UncrustifyCheck\mu-uncrustify-release_extdep\Windows-x86\uncrustify.exe -c .pytool\Plugin\UncrustifyCheck\uncrustify.cfg -F - --replace --no-backup --if-changed

If you know the package you are working on, the following one will work faster.

    git ls-files <PackageName>*.c <PackageName>*.h :!BaseTools/* | .pytool\Plugin\UncrustifyCheck\mu-uncrustify-release_extdep\Windows-x86\uncrustify.exe -c .pytool\Plugin\UncrustifyCheck\uncrustify.cfg -F - --replace --no-backup --if-changed

OvmfPkg Example:

    git ls-files OvmfPkg/*.c OvmfPkg/*.h :!BaseTools/* | .pytool\Plugin\UncrustifyCheck\mu-uncrustify-release_extdep\Windows-x86\uncrustify.exe -c .pytool\Plugin\UncrustifyCheck\uncrustify.cfg -F - --replace --no-backup --if-changed


You do have to use the .pytool stuart commands to setup your environment so uncrustify tool is installed automatically.
This also allows you to run all the EDK II CI tests locally if you want to check and fix issues before
submitting a PR.

    https://github.com/tianocore/edk2/blob/master/.pytool/Readme.md#running-ci-locally

You can also use git filter-branch to uncrustify a more complex patch series.  That is in the email thread
and will be included in the Wiki.

Best regards,

Mike

> -----Original Message-----
> From: devel@edk2.groups.io <devel@edk2.groups.io> On Behalf Of Michael Kubacki
> Sent: Tuesday, December 7, 2021 12:50 PM
> To: devel@edk2.groups.io; brijesh.singh@amd.com
> Subject: Re: [edk2-devel] EDK2 CI build error "Uncrustify Coding Standard"
> 
> Hi Brijesh,
> 
> A Tianocore wiki article is being prepared but the background and
> instructions for what to do were sent in this mail regarding the hard
> freeze being lifted - https://edk2.groups.io/g/devel/message/84458.
> 
> Do you have questions after reading through that?
> 
> Thanks,
> Michael
> 
> On 12/7/2021 2:52 PM, Brijesh Singh via groups.io wrote:
> > Hi All,
> >
> > I am rebasing the SNP series and encountering the error like below from
> > the CI. I am not sure what I am missing. For testing purpose, I just
> > tried one commit and CI Windows build complains about this. This is the
> > same patch which passed all the CI. Any idea what I maybe missing ?
> >
> >
> > WARNING - A file header template is not specified in the config file.
> > WARNING - A function header template is not specified in the config file.
> > ERROR - /home/vsts/work/1/s/OvmfPkg/Sec/AmdSev.c
> > ERROR - /home/vsts/work/1/s/OvmfPkg/Sec/AmdSev.h
> > ERROR - --->Test Failed: Uncrustify Coding Standard Test NO-TARGET
> > returned 2
> >
> >
> > My patch does add the two files and they are listed in .inf.
> >
> > -Brijesh
> >
> >
> >
> >
> 
> 
> 
>