(QEMU) Clarification on ENV VAR Usage #601
Merged
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.
Readiness
Overview
The note provided before the command might lead users to believe that the ENV VAR will automatically be utilized by QEMU during its execution. This can be misleading, especially for those unfamiliar with QEMU or the outlined solution. Personally, the necessity of exporting this variable wasn't clear to me until I reviewed the 'targets' section.
So I would like to suggest the following changes:
Before this PR:
Suggested changes in this PR
Checklist
Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.