docs: document detach as the transport option it is - #498
Merged
Conversation
`detach` was listed under "Running the container" in the driver's configuration, where setting it does nothing at all. The only place `config[:detach]` is read is `build_exec_command`, and the only thing that reaches it is the transport's container -- the driver's container never runs an exec. Its own description gives it away: it talks about provisioner commands and about `kitchen login`, both of which are the transport's business. Moved to the transport table, where setting it has the documented effect, with a pointer left behind for anyone who looks where it used to be. Also corrects `build_tempdir`, which is resolved against the working directory rather than against `build_context`. Signed-off-by: Tim Smith <tim@mondoo.com>
RulerOf
approved these changes
Aug 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
detachwas listed under Driver configuration → Running the container, where setting it does nothing at all.The only place
config[:detach]is read isCliHelper#build_exec_command:and the only thing that reaches that is the transport's container. The driver constructs a container too, but only ever calls
createanddestroyon it, neither of which runs an exec — so adetach: trueunderdriver:is read by nothing.Its own description gave it away: it talks about provisioner commands and about
kitchen login, both of which are the transport's business.What changed
detachmoved to the transport table, where setting it has the documented effect.build_tempdircorrected. It said "relative tobuild_context"; it is resolved against the working directory (Pathname.pwd + config[:build_tempdir]), anddockerfile_paththen makes the-fargument relative to the working directory too, which is what constrains where it can be.Documentation only — no behaviour change. I checked the rest of the option tables against
default_configand the config keyslib/actually reads while I was in here; everything else lines up, including the defaults.Verification