update flag-description for --cgroup-parent #1905
Merged
Conversation
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
This attempts to make it clearer that the --cgroup-parent option is only used for the containers used during build. Instead of mentioning "build container", I opted for using "RUN instructions" (to match the --network description), although this may not be ideal (as it assumes the "Dockerfile" front-end, which of course may not be the case). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
commented
Jun 23, 2023
| flags.StringArrayVar(&options.cacheTo, "cache-to", []string{}, `Cache export destinations (e.g., "user/app:cache", "type=local,dest=path/to/dir")`) | ||
|
|
||
| flags.StringVar(&options.cgroupParent, "cgroup-parent", "", "Optional parent cgroup for the container") | ||
| flags.StringVar(&options.cgroupParent, "cgroup-parent", "", `Set the parent cgroup for the "RUN" instructions during build`) |
Member
Author
There was a problem hiding this comment.
I'm definitely open to suggestions for the description (also see PR description above). Not sure what the least ambiguous description would be for this.
Contributor
|
I think it's safe to assume that "RUN" instruction is the most approachable way to convey this at the moment. IMO there's no better way to refer to "build container exec" that's also a one-liner. |
Member
Author
|
I'm considering; perhaps we should put the options in groups.
I added some "ad-hoc" grouping for commands in the CLI at some point But that one is really tacky, and really for "our specific purpose". ISTR though that Cobra also added some options to group things, so perhaps we need to look into that. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
docker build --cgroup-parent=/foodoesn't work moby/moby#34469 (comment)This attempts to make it clearer that the --cgroup-parent option is only used for the containers used during build. Instead of mentioning "build container", I opted for using "RUN instructions" (to match the --network description), although this may not be ideal (as it assumes the "Dockerfile" front-end, which of course may not be the case).