changeset 41:1c8aaaea72b2

runtime assertions
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 16 Sep 2016 08:57:28 +0200
parents 99b45a963bcf
children a52f1dc48ebc
files Sphinx/source/faq/compiling.rst Sphinx/source/faq/troubleshooting.rst
diffstat 2 files changed, 25 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/faq/compiling.rst	Fri Aug 19 08:59:32 2016 +0200
+++ b/Sphinx/source/faq/compiling.rst	Fri Sep 16 08:57:28 2016 +0200
@@ -27,6 +27,17 @@
 <https://bitbucket.org/sjodogne/orthanc/src/default/DarwinCompilation.txt>`_
 inside the source package.
 
+Performance warning
+-------------------
+
+If performance is important to you, make sure to add the option
+``-DCMAKE_BUILD_TYPE=Release`` when invoking ``cmake``. Indeed, by
+default, `run-time debug assertions
+<https://en.wikipedia.org/wiki/Assertion_(software_development)#Assertions_for_run-time_checking>`_
+are enabled, which can seriously impact performance, especially if
+your Orthanc server stores a lot of DICOM instances.
+
+
 
 Please explain the build infrastructure
 ---------------------------------------
--- a/Sphinx/source/faq/troubleshooting.rst	Fri Aug 19 08:59:32 2016 +0200
+++ b/Sphinx/source/faq/troubleshooting.rst	Fri Sep 16 08:57:28 2016 +0200
@@ -29,6 +29,20 @@
 Performance issues
 ------------------
 
+* **Run-time debug assertions**: If performance is important to you,
+  make sure to add the option ``-DCMAKE_BUILD_TYPE=Release`` when
+  invoking ``cmake`` while :ref:`compiling Orthanc
+  <compiling>`. Indeed, by default, `run-time debug assertions
+  <https://en.wikipedia.org/wiki/Assertion_(software_development)#Assertions_for_run-time_checking>`_
+  are enabled, which can seriously impact performance, especially if
+  your Orthanc server stores a lot of DICOM instances.
+
+  Note that the `official Docker images
+  <https://github.com/jodogne/OrthancDocker>`__ of Orthanc <= 1.0.0
+  were not compiled in ``Release`` mode. As a consequence, to improve
+  performance, make sure to use either the mainline version of the
+  container, or versions more recent than ``jodogne/orthanc:1.1.0``.
+
 * **Orthanc Explorer is slow under Windows on the localhost**:
 
   - Favor ``127.0.0.1`` instead of ``localhost`` when specifying the