[edk2-devel] [PATCH v1 1/7] .pytool: Set uncrustify check to audit only

[Michael Kubacki]

Looking at the whole series, I see you did this to prevent intermediate 
CI failures while adjusting the code to comply with the future settings 
change.

If it stays this way, the commit message should clearly call this out. 
For example:

"Temporarily set uncrustify to audit only mode so the following commits 
can adjust the code for new formatting settings before those settings 
are applied."

The scope could also be adjusted in uncrustify_plug_in.yaml to something 
other than "cibuild" that does not match known scopes (like "inactive") 
but I think this is fine if the message is clear about why the value is 
being temporarily modified.

Thanks,
Michael

On 8/14/2023 9:06 PM, Michael Kubacki wrote:
> Was this meant to be included in the series? We wouldn't want audit only 
> mode always enabled.
> 
> On 8/9/2023 5:32 PM, VivianNK wrote:
>> Temporarily set uncrustify to audit only to prevent build failures.
>>
>> CC: Sean Brogan <sean.brogan at microsoft.com>
>> CC: Michael Kubacki <mikuback at linux.microsoft.com>
>> CC: Michael D Kinney <michael.d.kinney at intel.com>
>> CC: Liming Gao <gaoliming at byosoft.com.cn>
>> Signed-off-by: Vivian Nowka-Keane <vnowkakeane at linux.microsoft.com>
>> ---
>>   .pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py 
>> b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
>> index 8dc9ffe6945a..8978ffc443bf 100644
>> --- a/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
>> +++ b/.pytool/Plugin/UncrustifyCheck/UncrustifyCheck.py
>> @@ -530,7 +530,7 @@ class UncrustifyCheck(ICiBuildPlugin):
>>           """
>>
>>           Initializes options that influence test case output.
>>
>>           """
>>
>> -        self._audit_only_mode = False
>>
>> +        self._audit_only_mode = True
>>
>>           self._output_file_diffs = True
>>
>>
>>           if "AuditOnly" in self._package_config and 
>> self._package_config["AuditOnly"]:
>>
> 
> 
> 
> 


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#107753): https://edk2.groups.io/g/devel/message/107753
Mute This Topic: https://groups.io/mt/100655290/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-