docs: clarify fakemachine runtime environment#308
Open
obbardc wants to merge 2 commits into
Open
Conversation
sjoerdsimons
reviewed
May 9, 2026
| .PP | ||
| The \(lqenvironment it is invoked from\(rq means the runtime environment | ||
| where fakemachine is started. | ||
| This can be a host system, a Docker/Podman container or a CI runner. |
Member
There was a problem hiding this comment.
what's a CI runner in this case and how is it not either a container or a host system?
sjoerdsimons
reviewed
May 9, 2026
| fakemachine uses that environment as the base for the VM rather than | ||
| constructing a separate root filesystem. | ||
| For example, when fakemachine is ran inside a Debian container, the VM | ||
| will effectively be based on that container\(cqs userspace. |
Member
There was a problem hiding this comment.
this whole paragraph seems a bit confusing as it feels like too many different terms are used to vaguely refer to the same thing. (e.g. root fs, userspace, runtime environment) and then mixing container, host system and ci runner.. Tbh. probably best to just focus on it re-using the current root file system (whether is a container rootfs or otherwise)
Clarify that fakemachine creates a VM using the current root filesystem rather than constructing a separate one. This may be the host root filesystem or, when fakemachine is run inside a container, the container root filesystem. Closes: #303 Signed-off-by: Christopher Obbard <christopher.obbard@linaro.org>
Signed-off-by: Christopher Obbard <christopher.obbard@linaro.org>
obbardc
force-pushed
the
wip/obbardc/readme-add-intended-use
branch
from
176adb8 to
fbceecd
Compare
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
2 participants
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.
Clarify what is meant by creating a VM from the "currently running system". The phrase refers to the environment fakemachine is invoked from: this may be a host system, container or CI runner.
Expand the README to describe that fakemachine is mainly used by debos to execute actions inside a VM derived from the current runtime environment. Also clarify that container usage is common but not required and that KVM is optional for acceleration rather than a hard dependency.
Closes: #303