Cleans up docs/man/Dockerfile.5.md #10674
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
0dc7497 to
9c5e0ac
Compare
|
|
||
| -- Runs the steps and commits them, building a final image | ||
| the path to the source repository defines where to find the context of the | ||
| build. The build is run by the docker daemon, not the CLI. The whole |
|
ping @LK4D4 is this not docs-review? you removed the label, I think it is, but @tiborvass would know best |
|
|
||
| -- specifies a repository and tag at which to save the new image if the build | ||
| succeeds. The Docker daemon runs the steps one-by-one, committing the result | ||
| to a new image if necessary before finally outputting the ID of the new |
|
There a lot of variance in formatting here - some Dockerfile instructions are wrapped in *, others are not. Use of versus command. I think some consistency is needed. |
docs/man/Dockerfile.5.md
<
8000
/div>
The **ONBUILD** instruction adds a trigger instruction to the image, which is
executed at a later time, when the image is used as the base for another
build. The trigger is executed in the context of the downstream build, as
if it had been inserted immediately after the FROM instruction in the
There was a problem hiding this comment.
This is not consistent. All commands/on-screen text needs to receive the same formatting.
| The **ONBUILD** instruction adds a trigger instruction to the image, which is | ||
| executed at a later time, when the image is used as the base for another | ||
| build. The trigger is executed in the context of the downstream build, as | ||
| if it had been inserted immediately after the FROM instruction in the |
There was a problem hiding this comment.
This is not consistent. All commands/on-screen text needs to receive the same formatting.
|
Formatting for commands is still not consistent throughout, but his is an improvement, so LGTM. |
9c5e0ac to
be3bf83
Compare
|
PTAL |
| combination with **CMD**. | ||
| If the user specifies arguments to docker run, the specified commands | ||
| override the default in **CMD**. | ||
| Do not confuse **RUN** with **CMD**. RUN runs a command and commits the result. |
|
Found a couple more, but LGTM still. |
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
be3bf83 to
14131b6
Compare
|
Updated with fred's notes. |
|
Still a handful of inconsistently formatted Dockerfile, but we have a separate ticket to deal with this issue site-wide, so I'm going to merge this. Thanks @cpuguy83 ! |
fredlf
pushed a commit
that referenced
this pull request
Feb 13, 2015
Cleans up docs/man/Dockerfile.5.md
SvenDowideit
pushed a commit
to SvenDowideit/docker
that referenced
this pull request
Feb 26, 2015
Cleans up docs/man/Dockerfile.5.md (cherry picked from commit ee95aa1)
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.
Fixes some improper usage of
**instead of backticksRe-arranged some things for readability.