( )⚙ D2641 docs: small fixes for profiling.nested and the overall description

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2641

docs: small fixes for profiling.nested and the overall description
ClosedPublic

Authored by spectral on Mar 4 2018, 11:41 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG0c431d3129c4: docs: small fixes for profiling.nested and the overall description
Summary
  • profiling.nested defaults to 0, not 5
  • profiling is not always done with lsprof

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

spectral created this revision.Mar 4 2018, 11:41 AM
pulkit accepted this revision.Mar 4 2018, 11:45 AM
Closed by commit rHG0c431d3129c4: docs: small fixes for profiling.nested and the overall description (authored by spectral). · Explain WhyMar 4 2018, 11:48 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/help/config.txt (5 lines)

Diff 6552

mercurial/help/config.txt

------------- -------------
Specifies profiling type, format, and file output. Two profilers are Specifies profiling type, format, and file output. Two profilers are
supported: an instrumenting profiler (named ``ls``), and a sampling supported: an instrumenting profiler (named ``ls``), and a sampling
profiler (named ``stat``). profiler (named ``stat``).
In this section description, 'profiling data' stands for the raw data In this section description, 'profiling data' stands for the raw data
collected during profiling, while 'profiling report' stands for a collected during profiling, while 'profiling report' stands for a
statistical text report generated from the profiling data. The statistical text report generated from the profiling data.
profiling is done using lsprof.
``enabled`` ``enabled``
Enable the profiler. Enable the profiler.
(default: false) (default: false)
This is equivalent to passing ``--profile`` on the command line. This is equivalent to passing ``--profile`` on the command line.
``type`` ``type``
``limit`` ``limit``
Number of lines to show. Specific to the ``ls`` instrumenting profiler. Number of lines to show. Specific to the ``ls`` instrumenting profiler.
(default: 30) (default: 30)
``nested`` ``nested``
Show at most this number of lines of drill-down info after each main entry. Show at most this number of lines of drill-down info after each main entry.
This can help explain the difference between Total and Inline. This can help explain the difference between Total and Inline.
Specific to the ``ls`` instrumenting profiler. Specific to the ``ls`` instrumenting profiler.
(default: 5) (default: 0)
``showmin`` ``showmin``
Minimum fraction of samples an entry must have for it to be displayed. Minimum fraction of samples an entry must have for it to be displayed.
Can be specified as a float between ``0.0`` and ``1.0`` or can have a Can be specified as a float between ``0.0`` and ``1.0`` or can have a
``%`` afterwards to allow values up to ``100``. e.g. ``5%``. ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
Only used by the ``stat`` profiler. Only used by the ``stat`` profiler.