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

[RFC] New inactive-by-default: project key #666

Open
mbolivar-nordic opened this issue Jun 1, 2023 · 2 comments
Open

[RFC] New inactive-by-default: project key #666

mbolivar-nordic opened this issue Jun 1, 2023 · 2 comments
Labels
Partial imports Incomplete or changing imports are much more complicated than you think

Comments

@mbolivar-nordic
Copy link
Contributor

This issue tracks a potential extension to the manifest schema. It is not a proposal at this point, just a placeholder for discussion.

Proposed syntax:

manifest:
  projects:
    - name: foo
      inactive-by-default: <true|false>

Proposed semantics:

  • if key is missing, no behavior changes
  • if key is false, no behavior changes
  • if key is true, new behavior applies to whether project is active or inactive

The new behavior that applies if and only if the key is true is:

  • if manifest.project-filter applies to the project, it decides whether the project is active or inactive; inactive-by-default has no effect in this case
  • otherwise, the project is inactive

This applies regardless of where the project is defined in the import hierarchy.

Concerns:

  • this can no longer be overridden in an importing manifest, so users will always have to take explicit action to enable such projects
  • in the case of zephyr/west.yml, west init + west update will not result in a manifest that can be resolved
@mbolivar-nordic
Copy link
Contributor Author

Discussion among @carlescufi @tejlmand @aescolar @mbolivar-nordic :

Fact that this cannot be overridden in an importing manifest is a serious problem. E.g. in NCS we could not write a manifest that imports zephyr and makes bsim active by default.

@mbolivar-nordic
Copy link
Contributor Author

Potential way forward, not vetted, just an RFC

manifest:
  projects:
    - name: zephyr
      import:
        name-allowlist:
          - bsim
          - ...
        activate:
          - bsim

@marc-hb marc-hb added the Partial imports Incomplete or changing imports are much more complicated than you think label Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Partial imports Incomplete or changing imports are much more complicated than you think
Projects
None yet
Development

No branches or pull requests

2 participants