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

Missing documentation on the structure of mixins #29

Open
allsey87 opened this issue Dec 16, 2021 · 1 comment
Open

Missing documentation on the structure of mixins #29

allsey87 opened this issue Dec 16, 2021 · 1 comment

Comments

@allsey87
Copy link

I am trying to understand how mixin are structured and have been unable to find any documentation on this. Taking compile-commands.mixin as an example, I understand that build is the verb to which this mixin applies and that cmake-args refers to the CMake build system, but what does compile-commands refer to? Is this the name of a specific package?

{
    "build": {
        "compile-commands": {
            "cmake-args": [
                "-DCMAKE_EXPORT_COMPILE_COMMANDS=ON",
                "--no-warn-unused-cli"
            ]
        }
    }
}

It would be great if a couple notes on this could be added to the README.md or over at readthedocs.

@christophebedard
Copy link
Contributor

compile-commands is the name of the mixin, so you'd use it like --mixin compile-commands.

If you remove the layer with the name of the mixin, the structure is similar to structures for .meta, colcon.pkg, and defaults.yaml files: https://colcon.readthedocs.io/en/released/user/configuration.html. Those also need more explicit documentation about their structure; there were similar comments/requests for this in the past.

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

No branches or pull requests

2 participants