changeset 176:01684f60a8ba

fix
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 03 Dec 2018 13:59:57 +0100
parents 2c87e18ace33
children 570f28208c5e
files Sphinx/source/users/docker.rst
diffstat 1 files changed, 19 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/users/docker.rst	Mon Dec 03 13:38:00 2018 +0100
+++ b/Sphinx/source/users/docker.rst	Mon Dec 03 13:59:57 2018 +0100
@@ -186,16 +186,29 @@
 Debugging
 ---------
 
+.. highlight:: text
+
 For debugging purpose, you can start an interactive bash session as
 follows::
 
   $ sudo docker run -i -t --rm --entrypoint=bash jodogne/orthanc
   $ sudo docker run -i -t --rm --entrypoint=bash jodogne/orthanc-plugins
 
-For developers, the images ``jodogne/orthanc-debug`` contain the
-Orthanc core compiled in debug mode (with runtime assertions enabled,
-and including debugging symbols). A ``gdb`` session can be started as
-follows::
+For developers and power users, the images ``jodogne/orthanc-debug``
+contain the Orthanc core compiled in debug mode (i.e. with runtime
+assertions enabled, and including debugging symbols). A ``gdb``
+session can be started as follows::
+
+  $ sudo docker run -i -t --rm --entrypoint=bash --cap-add=SYS_PTRACE -p 4242:4242 -p 8042:8042 jodogne/orthanc-debug
+  # gdb --args Orthanc /etc/orthanc/ --verbose
 
-  $ sudo docker run -i -t --rm --entrypoint=bash --cap-add=SYS_PTRACE -p 4242:4242 -p 8042:8042 orthanc-debug
-  # gdb --args Orthanc /etc/orthanc/
+Note that:
+
+* The plugins are not available in this image yet.
+
+* The Orthanc source code can be found in folder ``/root/orthanc``.
+
+* The build artifacts can be found in folder ``/root/orthanc/Build``.
+
+* This command launches the mainline version. To start a released version,
+  use e.g. ``jodogne/orthanc-debug:1.4.2``.