Browse code

use the Makefile in the dev environment documentation - its way less typing, and fewer typing mistakes

Sven Dowideit authored on 2013/12/05 20:48:35
Showing 1 changed files
... ...
@@ -42,9 +42,7 @@ This following command will build a development environment using the Dockerfile
42 42
 
43 43
 .. code-block:: bash
44 44
 
45
-    sudo docker build -t docker .
46
-
47
-
45
+    sudo make build
48 46
 
49 47
 If the build is successful, congratulations! You have produced a clean build of docker, neatly encapsulated in a standard build environment. 
50 48
 
... ...
@@ -56,7 +54,7 @@ To create the Docker binary, run this command:
56 56
 
57 57
 .. code-block:: bash
58 58
 
59
-	sudo docker run -privileged -v `pwd`:/go/src/github.com/dotcloud/docker docker hack/make.sh binary
59
+	sudo make binary
60 60
 
61 61
 This will create the Docker binary in ``./bundles/<version>-dev/binary/``
62 62
 
... ...
@@ -68,10 +66,15 @@ To execute the test cases, run this command:
68 68
 
69 69
 .. code-block:: bash
70 70
 
71
-	sudo docker run -privileged -v `pwd`:/go/src/github.com/dotcloud/docker docker hack/make.sh test
71
+	sudo make test
72
+
72 73
 
74
+Note: if you're running the tests in vagrant, you need to specify a dns entry in 
75
+the command (either edit the Makefile, or run the step manually): 
76
+
77
+.. code-block:: bash
73 78
 
74
-Note: if you're running the tests in vagrant, you need to specify a dns entry in the command: `-dns 8.8.8.8`
79
+	sudo docker run -dns 8.8.8.8 -privileged -v `pwd`:/go/src/github.com/dotcloud/docker docker hack/make.sh test
75 80
 
76 81
 If the test are successful then the tail of the output should look something like this
77 82
 
... ...
@@ -113,10 +116,22 @@ You can run an interactive session in the newly built container:
113 113
 
114 114
 .. code-block:: bash
115 115
 
116
-	sudo docker run -privileged -i -t docker bash
116
+	sudo make shell
117 117
 
118
-	# type 'exit' to exit
118
+	# type 'exit' or Ctrl-D to exit
119
+
120
+
121
+Extra Step: Build and view the Documenation
122
+-------------------------------------------
123
+
124
+If you want to read the documentation from a local website, or are making changes
125
+to it, you can build the documentation and then serve it by:
126
+
127
+.. code-block:: bash
119 128
 
129
+	sudo make doc
130
+    # when its done, you can point your browser to http://yourdockerhost:8000
131
+	# type Ctrl-C to exit
120 132
 
121 133
 
122 134
 .. note:: The binary is available outside the container in the directory  ``./bundles/<version>-dev/binary/``. You can swap your host docker executable with this binary for live testing - for example, on ubuntu: ``sudo service docker stop ; sudo cp $(which docker) $(which docker)_ ; sudo cp ./bundles/<version>-dev/binary/docker-<version>-dev $(which docker);sudo service docker start``.