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

Documentation: Add installation instructions for xmllint which is enabled by cbuild tool when -s #96

Closed
jkrech opened this issue Jan 4, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jkrech
Copy link
Member

jkrech commented Jan 4, 2024

Installation instructions lists ninja and cmake but not xmllint.

cbuild -s runs xmllint for all generated *.cprj before running cbuildgen to generate CMakeLists.txt files

see existing documentation: https://open-cmsis-pack.github.io/devtools/buildmgr/latest/cbuild_install.html#libxml
see also https://github.com/Open-CMSIS-Pack/gen-pack#xmllint as reference how to obtain/install xmllint.

@jkrech jkrech added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 4, 2024
@ReinhardKeil
Copy link
Contributor

Given the fact that *.cprj is a legacy format, should we remove the -s option from cbuild instead?

@jkrech
Copy link
Member Author

jkrech commented Jan 16, 2024

This issue got fixed: Open-CMSIS-Pack/devtools#1261
xmllint is only used in case of cbuild buildcprj --schema command
Please reject if this corner case use case is not important enough to explain the xmllint installation.

@ReinhardKeil
Copy link
Contributor

suggest to reject this issue.

@jkrech
Copy link
Member Author

jkrech commented Jan 23, 2024

Given the fact that we don't expect cprj formatted files are used as input for cbuild much, we decided not to extend/clutter the documentation potentially distracting new users.

@jkrech jkrech closed this as completed Jan 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants