diff Sphinx/source/faq/compiling.rst @ 42:a52f1dc48ebc

GNU/Linux
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 16 Sep 2016 09:14:59 +0200
parents 1c8aaaea72b2
children 329bcab46f5e
line wrap: on
line diff
--- a/Sphinx/source/faq/compiling.rst	Fri Sep 16 08:57:28 2016 +0200
+++ b/Sphinx/source/faq/compiling.rst	Fri Sep 16 09:14:59 2016 +0200
@@ -3,8 +3,8 @@
 Compiling Orthanc
 =================
 
-Under Linux
------------
+Under GNU/Linux
+---------------
 
 * Orthanc >= 0.7.1: See the `build instructions
   <https://bitbucket.org/sjodogne/orthanc/src/default/LinuxCompilation.txt>`_
@@ -45,7 +45,7 @@
 The build infrastructure of Orthanc is based upon `CMake
 <https://cmake.org/>`_. The build scripts are designed to embed all
 the third-party dependencies directly inside the Orthanc
-executable. This is the meaning of the ``-DSTATIC_BUILD=TRUE`` option,
+executable. This is the meaning of the ``-DSTATIC_BUILD=ON`` option,
 as described in the `INSTALL
 <https://bitbucket.org/sjodogne/orthanc/src/default/INSTALL>`_ file of Orthanc.
 
@@ -58,34 +58,34 @@
 `DLL hell <https://en.wikipedia.org/wiki/Dll_hell>`_. As a downside,
 this makes our build infrastructure rather complex.
 
-Static linking is not as desirable under Linux than under
-Windows. Linux prefers software that dynamically links against the
+Static linking is not as desirable under GNU/Linux than under
+Windows. GNU/Linux prefers software that dynamically links against the
 system-wide libraries: This is explained by the fact that whenever a
 third-party dependency benefits from a bugfix, any software that is
 linked against it also immediately benefits from this fix. This also
 reduces the size of the binaries as well as the build time. Under
-Linux, it is thus recommended to use the ``-DSTATIC_BUILD=FALSE``
+GNU/Linux, it is thus recommended to use the ``-DSTATIC_BUILD=OFF``
 option whenever possible.
 
 When the dynamic build is used, some third-party dependencies may be
-unavailable or incompatible with Orthanc, depending on your Linux
+unavailable or incompatible with Orthanc, depending on your GNU/Linux
 distribution. Some CMake options have thus been introduced to force
 the static linking against some individual third-party
 dependencies. Here are the most useful:
 
-* ``-DUSE_SYSTEM_DCMTK=FALSE`` to statically link against DCMTK.
-* ``-DUSE_SYSTEM_JSONCPP=FALSE`` to statically link against JsonCpp.
+* ``-DUSE_SYSTEM_DCMTK=OFF`` to statically link against DCMTK.
+* ``-DUSE_SYSTEM_JSONCPP=OFF`` to statically link against JsonCpp.
 
-You will also have to set the ``-DALLOW_DOWNLOADS=TRUE`` to
+You will also have to set the ``-DALLOW_DOWNLOADS=ON`` to
 explicitely allow the CMake script to download the source code of any
 required dependency. The source code of all these dependencies is
 self-hosted on our servers at the University Hospital of Liège.
 
-Please also note that the option ``-DSTANDALONE_BUILD=TRUE`` must be
+Please also note that the option ``-DSTANDALONE_BUILD=ON`` must be
 used whenever your plan to move the binaries or to install them on
 another computer. This option will embed all the external resource
 files (notably Orthanc Explorer) into the resulting executable. If
-this option is set to ``FALSE``, the resources will be read from the
+this option is set to ``OFF``, the resources will be read from the
 source directories.