-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Add networking reference link #4166
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add networking reference link #4166
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4166 +/- ##
=======================================
Coverage 59.64% 59.64%
=======================================
Files 287 287
Lines 24771 24771
=======================================
Hits 14774 14774
Misses 9111 9111
Partials 886 886 |
akerouanton
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
thaJeztah
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left a comment (I can catch up with you if needed)
docs/reference/commandline/build.md
Outdated
| | `-m`, `--memory` | `bytes` | `0` | Memory limit | | ||
| | `--memory-swap` | `bytes` | `0` | Swap limit equal to memory plus swap: -1 to enable unlimited swap | | ||
| | `--network` | `string` | `default` | Set the networking mode for the RUN instructions during build | | ||
| | `--network` | `string` | `default` | Set [the networking mode](https://docs.docker.com/network/) for the RUN instructions during build | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This table is actually generated from the source code (I thought we had a verify step for this one to check it, but looks like it doesn't flag this 🤔). The table in markdown is only used on GitHub (and generated from the YAML properties on docs.docker.com).
What I think we need here instead is to either add a section for this option further down (having the right anchor tag to match the flag name), and add the link for details in there, or perhaps we need to add a link to the buildx build documentation as alternative link (if that page does have a description).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, there don't actually appear to be many sections for more explanation in this doc. Is there any reason we can't add links to code comments? Or we'd just rather not?
|
Looks like @crazy-max do you know from the top of your head if BuildKit now has full feature-parity on |
|
@thaJeztah and @crazy-max Turns out my last change was linking people to the wrong place anyway and digging more into this it seems that |
Co-authored-by: Sebastiaan van Stijn <[email protected]> Signed-off-by: Chris Chinchilla <[email protected]>
aba7d62 to
64e9cad
Compare
|
Rebased, and squashed the commits |
thaJeztah
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM if CI is happy
- What I did
Added a link to
--networkingflag as requested in this issue docker/docs#16890Made it an "external" link for better usage in multiple locations.