Merge branch 'mstahl_devdoc' into 'master'

Linking lhcb-benchmark-scripts

See merge request !289

doc/tutorials/developing.rst

@@ -92,6 +92,17 @@ that performs some style and syntax checks:
 * The LHCb Python formatting rules must be adhered to.
 * The Python code must have valid syntax and not raise any `flake8 error codes`_.
 
+Timing, throughput and profiling
+--------------------------------
+
+An important question comes up sooner or later when developing an algorithm or making changes to an existing one: "How fast is this thing?". 
+In many scenarios, the timing table that is printed at the end of a job can give a sufficient estimate. 
+The timing table prints the total and average time per event for every algorithm, 
+and it is advisable to compare the timing changes of your algorithm relative to some algorithm earlier in
+the reconstruction chain, like the Velo tracking.
+If you need more details and for example want to create a flamegraph, we recommend following the instructions in the `lhcb-benchmark-scripts`_ repository.
+
+
 .. _lb-stack-setup: https://gitlab.cern.ch/rmatev/lb-stack-setup
 .. _Moore: https://gitlab.cern.ch/lhcb/Moore
 .. _Gaudi testing infrastructure: https://twiki.cern.ch/twiki/bin/view/Gaudi/GaudiTestingInfrastructure
@@ -102,6 +113,7 @@ that performs some style and syntax checks:
 .. _Sphinx: https://www.sphinx-doc.org/
 .. _CI pipeline: https://docs.gitlab.com/ee/ci/
 .. _flake8 error codes: http://flake8.pycqa.org/en/2.5.5/warnings.html
+.. _lhcb-benchmark-scripts: https://gitlab.cern.ch/lhcb-core/lhcb-benchmark-scripts/
 
 .. rubric:: Footnotes