6ffbb3581a
The EDK II C Coding Standards Specification states that: "Names starting with one or two underscores, such as _MACRO_GUARD_FILE_NAME_H_, must not be used. They are reserved for compiler implementation." [1] The Ecc tool currently checks that the include guard end with a trailing underscore. Thus, the check and the error message should both be modified. The new check forces having one sole trailing underscore character, as the example in the specification shows: "FILE_NAME_H_" [1] This would allow to have more consistency. [1] Section 5.3.5 "All include file contents must be protected by a #include guard": https://edk2-docs.gitbook.io/ edk-ii-c-coding-standards-specification/5_source_files/53_include_files Signed-off-by: Pierre Gondois <Pierre.Gondois@arm.com> Reviewed-by: Sami Mujawar <Sami.Mujawar@arm.com> Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn> |
||
|---|---|---|
| .. | ||
| AmlToC | ||
| AutoGen | ||
| BPDG | ||
| Capsule | ||
| Common | ||
| CommonDataClass | ||
| Ecc | ||
| Eot | ||
| GenFds | ||
| GenPatchPcdTable | ||
| PatchPcdValue | ||
| Pkcs7Sign | ||
| Rsa2048Sha256Sign | ||
| Split | ||
| Table | ||
| TargetTool | ||
| Trim | ||
| UPT | ||
| Workspace | ||
| build | ||
| tests/Split | ||
| GNUmakefile | ||
| Makefile | ||
| README.md | ||
| basetool_tiano_python_path_env.yaml | ||
| sitecustomize.py | ||
README.md
Edk2 Basetools
This folder has traditionally held the source of Python based tools used by EDK2.
The official repo this source has moved to https://github.com/tianocore/edk2-basetools.
This folder will remain in the tree until the next stable release (expected 202102).
There is a new folder under Basetools BinPipWrappers that uses the pip module rather than this tree for Basetools.
By adding the scope pipbuild-win or pipbuild-unix (depending on your host system), the SDE will use the
BinPipWrappers instead of the regular BinWrappers.
Why Move It?
The discussion is on the mailing list. The RFC is here: https://edk2.groups.io/g/rfc/topic/74009714#270 The benefits allow for the Basetools project to be used separately from EDK2 itself as well as offering it in a globally accessible manner. This makes it much easier to build a module using Basetools. Separating the Basetools into their own repo allows for easier CI and contribution process. Additional pros, cons, and process can be found on the mailing list.
How Do I Install It?
By default, EDK2 is tied to and tested with a specific version of the Basetools through pip-requirements.txt.
You can simply run:
pip install -r pip-requirements.txt
This will install the required module, thought we strongly suggest setting up a virtual environment. Additionally, you can also install a local clone of the Basetools as well as a specific git commit.