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

Inconsistency between parameter names for flags and include directories #113

Closed
GPMueller opened this issue Jul 9, 2020 · 0 comments · Fixed by #126
Closed

Inconsistency between parameter names for flags and include directories #113

GPMueller opened this issue Jul 9, 2020 · 0 comments · Fixed by #126
Labels
enhancement New feature or request

Comments

@GPMueller
Copy link
Contributor

GPMueller commented Jul 9, 2020

Currently, the config keywords are

  • include_directories
  • public_include_directories
    and
  • flags
  • interface-flags
  • public-flags

Note also that the documentation currently is quite unclear: https://clang-build.readthedocs.io/en/latest/user_guide/inheritance.html shows public-include-directories as title, but public_include_directories in the code example, while public-flags is the correct title but no code example is given.
On top of this, in our internal file-dicts the public include directories key is called 'include_directories_public'...


To make everything consistent, we should rename

  • interface-flags -> interface_flags
  • public-flags -> public_flags
  • file-dict key 'include_directories_public' -> 'public_include_directories'

And to improve the documentation, we should

  • add a new section (next to User's Guide?) called "Config file parameters", containing a reference of how/what one can set in a clang-build.toml
  • correct the inheritance documentation titles
  • extend the inheritance documentation by giving code examples
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

Successfully merging a pull request may close this issue.

1 participant