Clarify Mac OS X experience. Signed-off by: Mary Anthony (moxieandmore@g... #9657
Conversation
|
@moxiegirl it think your sign-off is not in the right format. Needs to be on a separate line, Perhaps you can amend your last commit and force-push, that should update the PR. Thanks! |
|
Hi, thanks, I amended the commit message. |
|
Hm. Automated test is still failing, please check the link for the right format, it has to be exactly like that, otherwise it is refused. Sorry for the hassle, but this will make it easier for the maintainers to review and merge your changes. :) |
Signed-off-by: Mary Anthony <moxieandmore@gmail.com>
|
For the want of a hyphen and two stinking parens! Hopefully it is sorted now. |
|
\o/ all green! Thanks! |
| This following command will build a development environment using the | ||
| Dockerfile in the current directory. Essentially, it will install all | ||
| This following command builds a development environment using the | ||
| Dockerfile in the current directory. Essentially, it installs all |
|
hey @moxiegirl would you like to make the requested changes to this PR, or would you like me to carry it? |
Signed-off-by: Mary Anthony <moxieandmore@gmail.com>
Signed-off-by: Mary Anthony <moxieandmore@gmail.com>
|
No worries. Updated per PR comments. |
|
|
||
| > **Note**: | ||
| > On Mac OS X, **do not** build Docker make targets such as `build`, `binary`, and `test` | ||
| > under root using the `sudo` command. |
There was a problem hiding this comment.
Let's clarify the relationships a little more:
On Mac OS X, Docker make targets such as build, binary, and test should not be built under root. Therefore, you shouldn't use sudo when running these commands on OS X.
There was a problem hiding this comment.
Fred, I actually find the use of "root" ambiguous in the original text. Can you clarify this for me? By root was it meant the root directory or the root user?
In my rewrite, I assumed the meaning was the "root" user because 1) isn't that the purpose of sudo in this case and 2) the make command as it appears in the example could only be run in the root directory where the makefile is located (if I recall correctly; I'm not at my desk to test).
The way the note reads to me now is "do not build in the root of the Docker repo" and "do not use sudo" -- is that the correct interpretation? Maybe the preposition "under" is the issue:
On Mac OS X, Docker make targets such as build, binary, and test should not be built as root. Therefore, you shouldn't use sudo when running these commands on OS X.
There was a problem hiding this comment.
I had assumed "root" meant "with root user privileges", but now I'm not sure about that assumption. Some testing would reveal the correct interpretation. Asking @SvenDowideit to weigh in might help too.
There was a problem hiding this comment.
it means to say, don't use sudo - and shouldn't imply anything wrt the path.
|
Not sure why tests are still failing. @SvenDowideit ? Also, you need to squash commits. Good changes otherwise. We should add the stuff about present tense to the style guide. Made one suggestion to clarify use of Thanks for the contribution. |
|
The last commit lacks a sign-off which is why the fail. |
Signed-off-by: Mary Anthony <moxieandmore@gmail.com>
|
LGTM - @jamtur01 ? |
Clarify Mac OS X experience. Signed-off by: Mary Anthony (moxieandmore@g...
Clarify Mac OS X experience. Signed-off by: Mary Anthony (moxieandmore@g... (cherry picked from commit 3e3749f) Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
|
Woot! Thanks gents. |
...mail.com)
Newb here just running through the process for setting up dev environment and contributing. In the process, I saw a chance to clarify some make instructions.