Clarify that --debug and --no-build are for debugging only

They output a Dockerfile that can not be used outside of
repo2docker, so are only useful as debugging aids.

Fixes #202
pull/205/head
yuvipanda 2018-02-01 00:48:43 -08:00
rodzic 8a5b1ef7a2
commit 1e88e313b6
1 zmienionych plików z 17 dodań i 8 usunięć

Wyświetl plik

@ -95,17 +95,26 @@ After building (it might take a while!), it should output a message in your term
If you copy/paste that URL into your browser you will see a Jupyter Notebook with the If you copy/paste that URL into your browser you will see a Jupyter Notebook with the
contents of the repository you have just built! contents of the repository you have just built!
Displaying the image Dockerfile Debugging the build process
------------------------------- ---------------------------
``repo2docker`` will generate a Dockerfile that composes the created Docker image. If you want to debug and understand the details of the docker image being built,
To see the contents of this Dockerfile without building the image use you can pass the ``debug`` parameter to the commandline. This will print the
the ``--debug`` and ``--no-build`` flags like so:: generated ``Dockerfile`` before building and running it.
jupyter-repo2docker --debug --no-build https://github.com/jakevdp/PythonDataScienceHandbook .. code-block:: bash
jupyter-repo2docker --debug https://github.com/jakevdp/PythonDataScienceHandbook
If you only want to see the ``Dockerfile`` output but not actually build it,
you can also pass ``--no-build`` to the commandline. This ``Dockerfile`` output
is for **debugging purposes** only - it can not be used by docker directly.
.. code-block:: bash
jupyter-repo2docker --no-build --debug https://github.com/jakevdp/PythonDataScienceHandbook
This will output the contents of the Dockerfile in your console. Note that it
will **not** build the image.
Accessing help from the command line Accessing help from the command line
------------------------------------ ------------------------------------