summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorTobias Kunze <r@rixx.de>2018-06-04 10:07:16 (GMT)
committerINADA Naoki <methane@users.noreply.github.com>2018-06-04 10:07:16 (GMT)
commitf7745e1dcb8e8473cc86112a0213b3f244a07230 (patch)
tree2ad62ed400b8147b159143f402f5281d6b61734c /Doc/library
parentb75ec0856771b51684b08c4e5068fbfad25c5e83 (diff)
downloadcpython-f7745e1dcb8e8473cc86112a0213b3f244a07230.zip
cpython-f7745e1dcb8e8473cc86112a0213b3f244a07230.tar.gz
cpython-f7745e1dcb8e8473cc86112a0213b3f244a07230.tar.bz2
bpo-27902: Add compatibility note to Profile docs (GH-7295)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/profile.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst
index 5dc0b2f..7b60426 100644
--- a/Doc/library/profile.rst
+++ b/Doc/library/profile.rst
@@ -327,11 +327,12 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class.
corresponding version of :mod:`profile` or :mod:`cProfile`. To be specific,
there is *no* file compatibility guaranteed with future versions of this
profiler, and there is no compatibility with files produced by other
- profilers. If several files are provided, all the statistics for identical
- functions will be coalesced, so that an overall view of several processes can
- be considered in a single report. If additional files need to be combined
- with data in an existing :class:`~pstats.Stats` object, the
- :meth:`~pstats.Stats.add` method can be used.
+ profilers, or the same profiler run on a different operating system. If
+ several files are provided, all the statistics for identical functions will
+ be coalesced, so that an overall view of several processes can be considered
+ in a single report. If additional files need to be combined with data in an
+ existing :class:`~pstats.Stats` object, the :meth:`~pstats.Stats.add` method
+ can be used.
Instead of reading the profile data from a file, a :class:`cProfile.Profile`
or :class:`profile.Profile` object can be used as the profile data source.