comparison mercurial/help/config.txt @ 36696:0c431d3129c4

docs: small fixes for profiling.nested and the overall description - profiling.nested defaults to 0, not 5 - profiling is not always done with lsprof Differential Revision: https://phab.mercurial-scm.org/D2641
author Kyle Lippincott <spectral@google.com>
date Thu, 15 Feb 2018 18:05:58 -0800
parents 9037c29e9f53
children 5890e5872f36
comparison
equal deleted inserted replaced
36695:c442c4a92ae8 36696:0c431d3129c4
1582 supported: an instrumenting profiler (named ``ls``), and a sampling 1582 supported: an instrumenting profiler (named ``ls``), and a sampling
1583 profiler (named ``stat``). 1583 profiler (named ``stat``).
1584 1584
1585 In this section description, 'profiling data' stands for the raw data 1585 In this section description, 'profiling data' stands for the raw data
1586 collected during profiling, while 'profiling report' stands for a 1586 collected during profiling, while 'profiling report' stands for a
1587 statistical text report generated from the profiling data. The 1587 statistical text report generated from the profiling data.
1588 profiling is done using lsprof.
1589 1588
1590 ``enabled`` 1589 ``enabled``
1591 Enable the profiler. 1590 Enable the profiler.
1592 (default: false) 1591 (default: false)
1593 1592
1655 1654
1656 ``nested`` 1655 ``nested``
1657 Show at most this number of lines of drill-down info after each main entry. 1656 Show at most this number of lines of drill-down info after each main entry.
1658 This can help explain the difference between Total and Inline. 1657 This can help explain the difference between Total and Inline.
1659 Specific to the ``ls`` instrumenting profiler. 1658 Specific to the ``ls`` instrumenting profiler.
1660 (default: 5) 1659 (default: 0)
1661 1660
1662 ``showmin`` 1661 ``showmin``
1663 Minimum fraction of samples an entry must have for it to be displayed. 1662 Minimum fraction of samples an entry must have for it to be displayed.
1664 Can be specified as a float between ``0.0`` and ``1.0`` or can have a 1663 Can be specified as a float between ``0.0`` and ``1.0`` or can have a
1665 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``. 1664 ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.