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 of --compilation.commands_dir is wrong #210

Open
saraedum opened this issue Jul 26, 2021 · 1 comment
Open

Documentation of --compilation.commands_dir is wrong #210

saraedum opened this issue Jul 26, 2021 · 1 comment

Comments

@saraedum
Copy link
Member

--compilation.commands_dir arg the directory where a
compile_commands.json is located, its
options have lower priority than the
other ones

However, the compile_commands.json does take preference, see https://github.com/standardese/standardese/blob/master/tool/generator.cpp#L36.

We should change the documentation to clarify that.

@matthijskooijman
Copy link

I just ran into this. Maybe it could be considered to change the implementation to match the documentation instead?

My usecase is documenting some embedded code that contains a check against the gcc version macros. For clangd, I have solved this with -fgnuc-version=10.0.0, which works in addition to the flags from the compilation database. For standardese, passing this option by itself works as expected, but once I use a compilation database it is ignored. Similarly -D options are ignored then, so that doesn't help me either...

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

No branches or pull requests

2 participants