From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from linux.microsoft.com (linux.microsoft.com [13.77.154.182])
 by mx.groups.io with SMTP id smtpd.web11.429.1637087128120994458
 for <devel@edk2.groups.io>;
 Tue, 16 Nov 2021 10:25:28 -0800
Authentication-Results: mx.groups.io;
 dkim=pass header.i=@linux.microsoft.com header.s=default header.b=E8vLSUHB;
 spf=pass (domain: linux.microsoft.com, ip: 13.77.154.182, mailfrom: mikuback@linux.microsoft.com)
Received: from [10.0.0.19] (c-73-27-179-174.hsd1.fl.comcast.net [73.27.179.174])
	by linux.microsoft.com (Postfix) with ESMTPSA id 4262C20C6374;
	Tue, 16 Nov 2021 10:25:27 -0800 (PST)
DKIM-Filter: OpenDKIM Filter v2.11.0 linux.microsoft.com 4262C20C6374
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linux.microsoft.com;
	s=default; t=1637087127;
	bh=C3bxTxhMQXRCLtMW5V9f4eu7IZ+Unyzgvkpr46G1k2Q=;
	h=Date:Subject:To:References:From:In-Reply-To:From;
	b=E8vLSUHBBF2rbnVfnnz/HEvYeZFORfa3sificWLdoEI2z2704ExYPBNce7aTfs5SW
	 8jEVDrlDmm1tjOLbFDulMmakn8pLl/hyE7XEtZy6XWyk016tapd6PLp7AguhA13+QY
	 1ksVB6pA1sU77ARoRIME1rmn0zRmBq8X59lTGJ8s=
Message-ID: <e6fdc68c-17b0-fe88-31fa-c5505c89f7be@linux.microsoft.com>
Date: Tue, 16 Nov 2021 13:25:26 -0500
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:91.0) Gecko/20100101
 Thunderbird/91.3.0
Subject: Re: [edk2-devel] Uncrustify configuration file and file/function templates
To: devel@edk2.groups.io, michael.d.kinney@intel.com
References: <CO1PR11MB492971BB2B7C796859E2A01AD2999@CO1PR11MB4929.namprd11.prod.outlook.com>
From: "Michael Kubacki" <mikuback@linux.microsoft.com>
In-Reply-To: <CO1PR11MB492971BB2B7C796859E2A01AD2999@CO1PR11MB4929.namprd11.prod.outlook.com>
Content-Language: en-US
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit

Hi Mike,

Those were just disabled because I typically run a separate invocation 
of Uncrustify with them enabled to isolate code which is missing 
file/function headers. My thought was the templates are helpful but we 
would need to individually identify where they are placed to file TCBZs 
for maintainers to replace the template with the actual information.

In some of my previous poc branches (like 
https://github.com/makubacki/edk2/commits/uncrustify_poc_3_with_headers), I 
also pushed a branch with those results.

So I do think we would want them enabled in the final config file. We 
can also review the contents of the templates in the future patch series 
to see if any changes are recommended.

I prefer using a .uncrustify directory to help group related collateral 
but I don't have a strong opinion there.

Thanks,
Michael

On 11/16/2021 12:16 PM, Michael D Kinney wrote:
> Hi Michael,
> 
> In your POC branch (https://github.com/makubacki/edk2/tree/uncrustify_poc_5), I see the
> uncrustify.cfg configuration file in the root.
> 
>      https://github.com/makubacki/edk2/blob/uncrustify_poc_5/uncrustify.cfg
> 
> However, in your Wiki, you provide examples where this configuration file is in an
> .uncrustify directory
> 
>      https://dev.azure.com/projectmu/Uncrustify/_wiki/wikis/Uncrustify.wiki/1/Project-Mu-(EDK-II)-Fork-Readme
> 
> The uncrustify.cfg files also contains commented out settings for the file header
> and function header templates.
> 
>      # cmt_insert_file_header          = default_file_header.txt
>      # cmt_insert_func_header          = default_function_header.txt
> 
> Are these disabled on purpose?
> 
> Do we want to enable them?  If so, should the uncrustify configuration file
> and the templates go into a .uncrustify directory?
> 
> Thanks,
> 
> Mike
> 
> 
> 
> 
> 
> 
>