[edk2-devel] [PATCH 0/3] BaseTools: Fix doc block location and formatting; run uncrustify

Rebecca Cran posted 3 patches 1 year, 1 month ago
Failed in applying to current master (apply log)
BaseTools/Source/C/Common/BinderFuncs.h             |   27 +-
BaseTools/Source/C/Common/CommonLib.h               |  267 ++--
BaseTools/Source/C/Common/Compress.h                |   45 +-
BaseTools/Source/C/Common/Crc32.h                   |   36 +-
BaseTools/Source/C/Common/Decompress.h              |  122 +-
BaseTools/Source/C/Common/EfiUtilityMsgs.h          |   38 +-
BaseTools/Source/C/Common/FirmwareVolumeBufferLib.h |  101 +-
BaseTools/Source/C/Common/FvLib.h                   |   51 +-
BaseTools/Source/C/Common/MemoryFile.h              |   76 +-
BaseTools/Source/C/Common/MyAlloc.h                 |  196 +--
BaseTools/Source/C/Common/OsPath.h                  |   92 +-
BaseTools/Source/C/Common/ParseGuidedSectionTools.h |  101 +-
BaseTools/Source/C/Common/ParseInf.h                |  228 ++--
BaseTools/Source/C/Common/PcdValueCommon.h          |  196 +--
BaseTools/Source/C/Common/PeCoffLib.h               |   66 +-
BaseTools/Source/C/Common/SimpleFileParsing.h       |   24 +-
BaseTools/Source/C/Common/StringFuncs.h             |  203 +--
BaseTools/Source/C/Common/WinNtInclude.h            |   28 +-
BaseTools/Source/C/Common/BasePeCoff.c              | 1068 +++++++--------
BaseTools/Source/C/Common/BinderFuncs.c             |   31 +-
BaseTools/Source/C/Common/CommonLib.c               |  914 ++++++-------
BaseTools/Source/C/Common/Crc32.c                   |   38 +-
BaseTools/Source/C/Common/Decompress.c              |  795 +++++------
BaseTools/Source/C/Common/EfiCompress.c             | 1189 ++++++++--------
BaseTools/Source/C/Common/EfiUtilityMsgs.c          |  663 ++++-----
BaseTools/Source/C/Common/FirmwareVolumeBuffer.c    | 1426 ++++++++------------
BaseTools/Source/C/Common/FvLib.c                   |  638 ++++-----
BaseTools/Source/C/Common/MemoryFile.c              |  131 +-
BaseTools/Source/C/Common/MyAlloc.c                 |  265 ++--
BaseTools/Source/C/Common/OsPath.c                  |  180 +--
BaseTools/Source/C/Common/ParseGuidedSectionTools.c |  142 +-
BaseTools/Source/C/Common/ParseInf.c                |  401 +++---
BaseTools/Source/C/Common/PcdValueCommon.c          |  618 ++++-----
BaseTools/Source/C/Common/PeCoffLoaderEx.c          |  277 ++--
BaseTools/Source/C/Common/SimpleFileParsing.c       |  737 +++++-----
BaseTools/Source/C/Common/StringFuncs.c             |  310 ++---
BaseTools/Source/C/Common/TianoCompress.c           | 1075 ++++++---------
37 files changed, 5544 insertions(+), 7251 deletions(-)
[edk2-devel] [PATCH 0/3] BaseTools: Fix doc block location and formatting; run uncrustify
Posted by Rebecca Cran 1 year, 1 month ago
Fix the formatting and location of documentation blocks in Source/C/Common,
and replace the duplicate prototype of __PcdSet with __PcdGet. Those patches
will fail CI because it appears Uncrustify was never run on BaseTools?

Patch 3/3 reformats the files in Source/C/Common according to
Uncrustify.

Rebecca Cran (3):
  BaseTools: Source/C/Common: Fix doc block locations and convert to
    Doxygen
  BaseTools: Replace duplicate __PcdSet prototype with __PcdGet
  BaseTools: Run Uncrustify over files in Source/C/Common

 BaseTools/Source/C/Common/BinderFuncs.h             |   27 +-
 BaseTools/Source/C/Common/CommonLib.h               |  267 ++--
 BaseTools/Source/C/Common/Compress.h                |   45 +-
 BaseTools/Source/C/Common/Crc32.h                   |   36 +-
 BaseTools/Source/C/Common/Decompress.h              |  122 +-
 BaseTools/Source/C/Common/EfiUtilityMsgs.h          |   38 +-
 BaseTools/Source/C/Common/FirmwareVolumeBufferLib.h |  101 +-
 BaseTools/Source/C/Common/FvLib.h                   |   51 +-
 BaseTools/Source/C/Common/MemoryFile.h              |   76 +-
 BaseTools/Source/C/Common/MyAlloc.h                 |  196 +--
 BaseTools/Source/C/Common/OsPath.h                  |   92 +-
 BaseTools/Source/C/Common/ParseGuidedSectionTools.h |  101 +-
 BaseTools/Source/C/Common/ParseInf.h                |  228 ++--
 BaseTools/Source/C/Common/PcdValueCommon.h          |  196 +--
 BaseTools/Source/C/Common/PeCoffLib.h               |   66 +-
 BaseTools/Source/C/Common/SimpleFileParsing.h       |   24 +-
 BaseTools/Source/C/Common/StringFuncs.h             |  203 +--
 BaseTools/Source/C/Common/WinNtInclude.h            |   28 +-
 BaseTools/Source/C/Common/BasePeCoff.c              | 1068 +++++++--------
 BaseTools/Source/C/Common/BinderFuncs.c             |   31 +-
 BaseTools/Source/C/Common/CommonLib.c               |  914 ++++++-------
 BaseTools/Source/C/Common/Crc32.c                   |   38 +-
 BaseTools/Source/C/Common/Decompress.c              |  795 +++++------
 BaseTools/Source/C/Common/EfiCompress.c             | 1189 ++++++++--------
 BaseTools/Source/C/Common/EfiUtilityMsgs.c          |  663 ++++-----
 BaseTools/Source/C/Common/FirmwareVolumeBuffer.c    | 1426 ++++++++------------
 BaseTools/Source/C/Common/FvLib.c                   |  638 ++++-----
 BaseTools/Source/C/Common/MemoryFile.c              |  131 +-
 BaseTools/Source/C/Common/MyAlloc.c                 |  265 ++--
 BaseTools/Source/C/Common/OsPath.c                  |  180 +--
 BaseTools/Source/C/Common/ParseGuidedSectionTools.c |  142 +-
 BaseTools/Source/C/Common/ParseInf.c                |  401 +++---
 BaseTools/Source/C/Common/PcdValueCommon.c          |  618 ++++-----
 BaseTools/Source/C/Common/PeCoffLoaderEx.c          |  277 ++--
 BaseTools/Source/C/Common/SimpleFileParsing.c       |  737 +++++-----
 BaseTools/Source/C/Common/StringFuncs.c             |  310 ++---
 BaseTools/Source/C/Common/TianoCompress.c           | 1075 ++++++---------
 37 files changed, 5544 insertions(+), 7251 deletions(-)

-- 
2.37.1 (Apple Git-137.1)



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#100497): https://edk2.groups.io/g/devel/message/100497
Mute This Topic: https://groups.io/mt/97218957/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
[edk2-devel] 回复: [PATCH 0/3] BaseTools: Fix doc block location and formatting; run uncrustify
Posted by gaoliming via groups.io 1 year ago
Rebecca:
  I think these changes are good. Reviewed-by: Liming Gao
<gaoliming@byosoft.com.cn>

  Besides, which tool is used to convert function comments to Doxygen
format?

Thanks
Liming
> -----邮件原件-----
> 发件人: Rebecca Cran <rebecca@bsdio.com>
> 发送时间: 2023年2月25日 8:54
> 收件人: devel@edk2.groups.io; Bob Feng <bob.c.feng@intel.com>; Liming
> Gao <gaoliming@byosoft.com.cn>; Yuwei Chen <yuwei.chen@intel.com>
> 抄送: Rebecca Cran <rebecca@bsdio.com>
> 主题: [PATCH 0/3] BaseTools: Fix doc block location and formatting; run
> uncrustify
> 
> Fix the formatting and location of documentation blocks in
Source/C/Common,
> and replace the duplicate prototype of __PcdSet with __PcdGet. Those
> patches
> will fail CI because it appears Uncrustify was never run on BaseTools?
> 
> Patch 3/3 reformats the files in Source/C/Common according to
> Uncrustify.
> 
> Rebecca Cran (3):
>   BaseTools: Source/C/Common: Fix doc block locations and convert to
>     Doxygen
>   BaseTools: Replace duplicate __PcdSet prototype with __PcdGet
>   BaseTools: Run Uncrustify over files in Source/C/Common
> 
>  BaseTools/Source/C/Common/BinderFuncs.h             |   27 +-
>  BaseTools/Source/C/Common/CommonLib.h               |  267 ++--
>  BaseTools/Source/C/Common/Compress.h                |   45 +-
>  BaseTools/Source/C/Common/Crc32.h                   |   36 +-
>  BaseTools/Source/C/Common/Decompress.h              |  122 +-
>  BaseTools/Source/C/Common/EfiUtilityMsgs.h          |   38 +-
>  BaseTools/Source/C/Common/FirmwareVolumeBufferLib.h |  101 +-
>  BaseTools/Source/C/Common/FvLib.h                   |   51 +-
>  BaseTools/Source/C/Common/MemoryFile.h              |   76 +-
>  BaseTools/Source/C/Common/MyAlloc.h                 |  196 +--
>  BaseTools/Source/C/Common/OsPath.h                  |   92 +-
>  BaseTools/Source/C/Common/ParseGuidedSectionTools.h |  101 +-
>  BaseTools/Source/C/Common/ParseInf.h                |  228 ++--
>  BaseTools/Source/C/Common/PcdValueCommon.h          |  196 +--
>  BaseTools/Source/C/Common/PeCoffLib.h               |   66 +-
>  BaseTools/Source/C/Common/SimpleFileParsing.h       |   24 +-
>  BaseTools/Source/C/Common/StringFuncs.h             |  203 +--
>  BaseTools/Source/C/Common/WinNtInclude.h            |   28 +-
>  BaseTools/Source/C/Common/BasePeCoff.c              | 1068
> +++++++--------
>  BaseTools/Source/C/Common/BinderFuncs.c             |   31 +-
>  BaseTools/Source/C/Common/CommonLib.c               |  914
> ++++++-------
>  BaseTools/Source/C/Common/Crc32.c                   |   38 +-
>  BaseTools/Source/C/Common/Decompress.c              |  795
> +++++------
>  BaseTools/Source/C/Common/EfiCompress.c             | 1189
> ++++++++--------
>  BaseTools/Source/C/Common/EfiUtilityMsgs.c          |  663 ++++-----
>  BaseTools/Source/C/Common/FirmwareVolumeBuffer.c    | 1426
> ++++++++------------
>  BaseTools/Source/C/Common/FvLib.c                   |  638
> ++++-----
>  BaseTools/Source/C/Common/MemoryFile.c              |  131 +-
>  BaseTools/Source/C/Common/MyAlloc.c                 |  265 ++--
>  BaseTools/Source/C/Common/OsPath.c                  |  180 +--
>  BaseTools/Source/C/Common/ParseGuidedSectionTools.c |  142 +-
>  BaseTools/Source/C/Common/ParseInf.c                |  401 +++---
>  BaseTools/Source/C/Common/PcdValueCommon.c          |  618
> ++++-----
>  BaseTools/Source/C/Common/PeCoffLoaderEx.c          |  277 ++--
>  BaseTools/Source/C/Common/SimpleFileParsing.c       |  737
> +++++-----
>  BaseTools/Source/C/Common/StringFuncs.c             |  310 ++---
>  BaseTools/Source/C/Common/TianoCompress.c           | 1075
> ++++++---------
>  37 files changed, 5544 insertions(+), 7251 deletions(-)
> 
> --
> 2.37.1 (Apple Git-137.1)





-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#100976): https://edk2.groups.io/g/devel/message/100976
Mute This Topic: https://groups.io/mt/97512207/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
Re: [edk2-devel] 回复: [PATCH 0/3] BaseTools: Fix doc block location and formatting; run uncrustify
Posted by Rebecca Cran 1 year ago
I'm not aware of a tool: I converted the comments manually.


-- 
Rebecca Cran


On 3/9/23 7:57 PM, gaoliming wrote:
> Rebecca:
>    I think these changes are good. Reviewed-by: Liming Gao
> <gaoliming@byosoft.com.cn>
>
>    Besides, which tool is used to convert function comments to Doxygen
> format?
>
> Thanks
> Liming
>> -----邮件原件-----
>> 发件人: Rebecca Cran <rebecca@bsdio.com>
>> 发送时间: 2023年2月25日 8:54
>> 收件人: devel@edk2.groups.io; Bob Feng <bob.c.feng@intel.com>; Liming
>> Gao <gaoliming@byosoft.com.cn>; Yuwei Chen <yuwei.chen@intel.com>
>> 抄送: Rebecca Cran <rebecca@bsdio.com>
>> 主题: [PATCH 0/3] BaseTools: Fix doc block location and formatting; run
>> uncrustify
>>
>> Fix the formatting and location of documentation blocks in
> Source/C/Common,
>> and replace the duplicate prototype of __PcdSet with __PcdGet. Those
>> patches
>> will fail CI because it appears Uncrustify was never run on BaseTools?
>>
>> Patch 3/3 reformats the files in Source/C/Common according to
>> Uncrustify.
>>
>> Rebecca Cran (3):
>>    BaseTools: Source/C/Common: Fix doc block locations and convert to
>>      Doxygen
>>    BaseTools: Replace duplicate __PcdSet prototype with __PcdGet
>>    BaseTools: Run Uncrustify over files in Source/C/Common
>>
>>   BaseTools/Source/C/Common/BinderFuncs.h             |   27 +-
>>   BaseTools/Source/C/Common/CommonLib.h               |  267 ++--
>>   BaseTools/Source/C/Common/Compress.h                |   45 +-
>>   BaseTools/Source/C/Common/Crc32.h                   |   36 +-
>>   BaseTools/Source/C/Common/Decompress.h              |  122 +-
>>   BaseTools/Source/C/Common/EfiUtilityMsgs.h          |   38 +-
>>   BaseTools/Source/C/Common/FirmwareVolumeBufferLib.h |  101 +-
>>   BaseTools/Source/C/Common/FvLib.h                   |   51 +-
>>   BaseTools/Source/C/Common/MemoryFile.h              |   76 +-
>>   BaseTools/Source/C/Common/MyAlloc.h                 |  196 +--
>>   BaseTools/Source/C/Common/OsPath.h                  |   92 +-
>>   BaseTools/Source/C/Common/ParseGuidedSectionTools.h |  101 +-
>>   BaseTools/Source/C/Common/ParseInf.h                |  228 ++--
>>   BaseTools/Source/C/Common/PcdValueCommon.h          |  196 +--
>>   BaseTools/Source/C/Common/PeCoffLib.h               |   66 +-
>>   BaseTools/Source/C/Common/SimpleFileParsing.h       |   24 +-
>>   BaseTools/Source/C/Common/StringFuncs.h             |  203 +--
>>   BaseTools/Source/C/Common/WinNtInclude.h            |   28 +-
>>   BaseTools/Source/C/Common/BasePeCoff.c              | 1068
>> +++++++--------
>>   BaseTools/Source/C/Common/BinderFuncs.c             |   31 +-
>>   BaseTools/Source/C/Common/CommonLib.c               |  914
>> ++++++-------
>>   BaseTools/Source/C/Common/Crc32.c                   |   38 +-
>>   BaseTools/Source/C/Common/Decompress.c              |  795
>> +++++------
>>   BaseTools/Source/C/Common/EfiCompress.c             | 1189
>> ++++++++--------
>>   BaseTools/Source/C/Common/EfiUtilityMsgs.c          |  663 ++++-----
>>   BaseTools/Source/C/Common/FirmwareVolumeBuffer.c    | 1426
>> ++++++++------------
>>   BaseTools/Source/C/Common/FvLib.c                   |  638
>> ++++-----
>>   BaseTools/Source/C/Common/MemoryFile.c              |  131 +-
>>   BaseTools/Source/C/Common/MyAlloc.c                 |  265 ++--
>>   BaseTools/Source/C/Common/OsPath.c                  |  180 +--
>>   BaseTools/Source/C/Common/ParseGuidedSectionTools.c |  142 +-
>>   BaseTools/Source/C/Common/ParseInf.c                |  401 +++---
>>   BaseTools/Source/C/Common/PcdValueCommon.c          |  618
>> ++++-----
>>   BaseTools/Source/C/Common/PeCoffLoaderEx.c          |  277 ++--
>>   BaseTools/Source/C/Common/SimpleFileParsing.c       |  737
>> +++++-----
>>   BaseTools/Source/C/Common/StringFuncs.c             |  310 ++---
>>   BaseTools/Source/C/Common/TianoCompress.c           | 1075
>> ++++++---------
>>   37 files changed, 5544 insertions(+), 7251 deletions(-)
>>
>> --
>> 2.37.1 (Apple Git-137.1)
>
>


-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#101017): https://edk2.groups.io/g/devel/message/101017
Mute This Topic: https://groups.io/mt/97512207/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-