From 07bed8ab386147cb49344b7194b4557515aab139 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Sat, 13 Dec 2014 14:18:46 -0800 Subject: [PATCH 1/4] Clarify Mac OS X experience. Signed-off-by: Mary Anthony Upstream-commit: 228404860ca12ea5fb09098bc2a1a16cc96c7e10 Component: engine --- .../sources/contributing/devenvironment.md | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/components/engine/docs/sources/contributing/devenvironment.md b/components/engine/docs/sources/contributing/devenvironment.md index f39dec6708..42a73827b9 100644 --- a/components/engine/docs/sources/contributing/devenvironment.md +++ b/components/engine/docs/sources/contributing/devenvironment.md @@ -40,22 +40,24 @@ with the name of branch or revision number. ## Build the Environment -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 the build and runtime dependencies necessary to build and test Docker. -This command will take some time to complete when you first execute it. +Your first build will take some time to complete. On Linux systems: $ sudo make build + +On Mac OS X, from within the `boot2docker` shell: + + $ make build + +> **Note**: +> On Mac OS X, **do not** build Docker make targets such as `build`, `binary`, and `test` +> under root (sudo). If the build is successful, congratulations! You have produced a clean build of docker, neatly encapsulated in a standard build environment. -> **Note**: -> On Mac OS X, make targets such as `build`, `binary`, and `test` -> must **not** be built under root. So, for example, instead of the above -> command, issue: -> -> $ make build ## Build the Docker Binary From 925862a57af849b23edc18000b16b52ccc095eb2 Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Tue, 16 Dec 2014 10:14:03 -0800 Subject: [PATCH 2/4] Updating per PR comments Signed-off-by: Mary Anthony Upstream-commit: 46748f1302c236457f0b646a746a9c945200ed12 Component: engine --- components/engine/docs/sources/contributing/devenvironment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/engine/docs/sources/contributing/devenvironment.md b/components/engine/docs/sources/contributing/devenvironment.md index 42a73827b9..194c164330 100644 --- a/components/engine/docs/sources/contributing/devenvironment.md +++ b/components/engine/docs/sources/contributing/devenvironment.md @@ -53,7 +53,7 @@ On Mac OS X, from within the `boot2docker` shell: > **Note**: > On Mac OS X, **do not** build Docker make targets such as `build`, `binary`, and `test` -> under root (sudo). +> under root using the `sudo` command. If the build is successful, congratulations! You have produced a clean build of docker, neatly encapsulated in a standard build environment. From 1fd98314404a596fab7024658052e9cc5fb78a1c Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Tue, 16 Dec 2014 10:16:20 -0800 Subject: [PATCH 3/4] Updating per PR comment Signed-off-by: Mary Anthony Upstream-commit: 078ac9ca456af1ecfc283a43aa60328ac800b205 Component: engine --- components/engine/docs/sources/contributing/devenvironment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/engine/docs/sources/contributing/devenvironment.md b/components/engine/docs/sources/contributing/devenvironment.md index 194c164330..5030a2d751 100644 --- a/components/engine/docs/sources/contributing/devenvironment.md +++ b/components/engine/docs/sources/contributing/devenvironment.md @@ -41,7 +41,7 @@ with the name of branch or revision number. ## Build the Environment This following command builds a development environment using the -Dockerfile in the current directory. Essentially, it installs all +`Dockerfile` in the current directory. Essentially, it installs all the build and runtime dependencies necessary to build and test Docker. Your first build will take some time to complete. On Linux systems: From bdb7f879f7a1958e3cca2d88b759d1f15048c3bc Mon Sep 17 00:00:00 2001 From: Mary Anthony Date: Thu, 18 Dec 2014 09:10:08 -0800 Subject: [PATCH 4/4] Argghhh...I need to automate that signoff. Fixing lack of signoff Signed-off-by: Mary Anthony Upstream-commit: 801fd1af256134b749ee3dd29ea5ed41d2594482 Component: engine --- .../engine/docs/sources/contributing/devenvironment.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/components/engine/docs/sources/contributing/devenvironment.md b/components/engine/docs/sources/contributing/devenvironment.md index 5030a2d751..c9efd3bf93 100644 --- a/components/engine/docs/sources/contributing/devenvironment.md +++ b/components/engine/docs/sources/contributing/devenvironment.md @@ -52,8 +52,9 @@ On Mac OS X, from within the `boot2docker` shell: $ make build > **Note**: -> On Mac OS X, **do not** build Docker make targets such as `build`, `binary`, and `test` -> under root using the `sudo` command. +> On Mac OS X, the Docker make targets such as `build`, `binary`, and `test` +> should **not** be built by the 'root' user. Therefore, you shouldn't use `sudo` when +> running these commands on OS X. If the build is successful, congratulations! You have produced a clean build of docker, neatly encapsulated in a standard build environment.