From a5c41d6b19ba7095bea8ad894ac3fd8f72a9a38d Mon Sep 17 00:00:00 2001 From: Dhanya Thattil Date: Thu, 29 Oct 2020 15:53:37 +0100 Subject: [PATCH] wip doc --- docs/src/installation.rst | 2 ++ docs/src/slsreceiver.rst | 15 +++++++++++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/docs/src/installation.rst b/docs/src/installation.rst index cca0d1d7d..7f187cd55 100644 --- a/docs/src/installation.rst +++ b/docs/src/installation.rst @@ -21,6 +21,8 @@ Installation ============================================== +.. _build from source using cmake: + Build from source using CMake --------------------------------- diff --git a/docs/src/slsreceiver.rst b/docs/src/slsreceiver.rst index ec637b92d..0ce938363 100644 --- a/docs/src/slsreceiver.rst +++ b/docs/src/slsreceiver.rst @@ -151,9 +151,20 @@ Please refer to Receiver PC Tuning options and slsReceiver Tuning under `Trouble Using Callbacks ---------------- -| One can get a callback in the receiver for each frame to: +One can get a callback in the receiver for each frame to: * manipulate the data that will be written to file, or * disable file writing in slsReceiver and take care of the data for each call back -| When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full. +When handling callbacks, the control should be returned as soon as possible, to prevent packet loss from fifo being full. +**Example** + * `main cpp file `_ + * `cmake file `_. + * how to install the slsDetectorPackage is provided :ref:`here `. + * compile the example **e4-rxr** by: + + .. code-block:: bash + + cmake ../path/to/your/source -DCMAKE_PREFIX_PATH=/path/to/sls/install + make +