Skip to content

docs: clarify container command wrapper workflows#522

Closed
gcomneno wants to merge 1 commit into
yoctoproject:stagingfrom
gcomneno:docs/container-command-wrapper
Closed

docs: clarify container command wrapper workflows#522
gcomneno wants to merge 1 commit into
yoctoproject:stagingfrom
gcomneno:docs/container-command-wrapper

Conversation

@gcomneno
Copy link
Copy Markdown
Contributor

Summary

Document advanced bitbake.commandWrapper workflows for container-based setups.

This adds examples for:

  • forwarding generated BitBake commands into an already-running container with docker exec
  • passing generated commands through a wrapper script into a Makefile target
  • keeping configured paths valid from the environment where the wrapped command runs
  • making wrapper scripts executable

Validation

  • git diff --check
  • npm run lint

Document how to use wrapper scripts for running BitBake commands inside already-running containers or Makefile-driven container setups.
@gcomneno
Copy link
Copy Markdown
Contributor Author

This documentation update is intended to capture the currently documented workaround direction for advanced container setups discussed in issues like #450, #415, and #416.

I avoided changing runtime behavior here and kept the PR focused on commandWrapper wrapper-script patterns for already-running containers and Makefile-driven environments.

Copy link
Copy Markdown
Member

@deribaucourt deribaucourt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this documentation is part of the scope of this extension. The extension doesn't provide guidance on executing Yocto within a reproducible docker or scripted environment. Since many users do, we provide features to integrate with it, but we don't aim to help people set it up. Several technologies exist, but the only official one is oe-init-build-env, which is the default and most documented approach for our settings.

The only responsibility of this extension is to document how to configure it for docker for the users who will need it. I think the current wrappers cover the most common use cases allready.

Also we absolutely won't recommend invoking bitbake under Makefile. Please don't do this. Users who unfortunately inherited from such a setup can refer to some issues discussions which describe possible approaches like this one.

So far I'm not convinced in keeping any of this PR for the reasons above. Do you identify a particular lack of documentation that would fall in the scope described above

@gcomneno
Copy link
Copy Markdown
Contributor Author

Thanks for the clear scope boundary.

That makes sense. I’ll close this PR rather than keep pushing documentation that goes beyond the extension’s responsibility.

For future documentation contributions, I’ll keep the focus on how to configure extension features themselves, rather than guidance for setting up Yocto/container/Makefile-based environments.

@gcomneno gcomneno closed this May 27, 2026
@gcomneno gcomneno deleted the docs/container-command-wrapper branch May 27, 2026 14:02
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

Successfully merging this pull request may close these issues.

2 participants