Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature]: Generate JSON Compilation Database as part of build process #87

Open
gapalomi opened this issue Feb 27, 2023 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@gapalomi
Copy link
Contributor

What does the feature solve?

Modern IDE's make use of compilation database json files to enable advanced features.
Request is to generate compile_commands.json file as part of build process.
JSON Compilation Database Format Specification
EDK2 bugzilla

Describe the solution

Add -Y REPORT_INFO option to build command to generate compile
information as part of BuildReport.
This option generates files to be used by external tools as IDE's
to enhance functionality.
Files are created inside build folder:
<Build>/<BuildTarget>/<ToolChain>/CompileInfo

Files created:

  • compile_commands.json - Compilation Database. To be used by IDE's
    to enable advance features
  • cscope.files - List of files used in compilation. Used by Cscope to parse
    C code and provide browse functionality.
  • module_report.json - Module data form buildReport in Json format.

Have you considered any alternatives?

Currently comunity uses external tools that parses build log output to generate this information such as Bear

Additional context

No response

@gapalomi gapalomi added the enhancement New feature or request label Feb 27, 2023
@gapalomi
Copy link
Contributor Author

Pull request for feature #88

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant