[docs] [issue15369] pybench and test.pystone poorly documented

[Marc-Andre Lemburg]

Marc-Andre Lemburg added the comment:

Please add notes to the Tools/README pointing users to the performance suite.

I'd also like to request that you reword this dismissive line in the performance package's readme:

"""
pybench - run the standard Python PyBench benchmark suite. This is considered an unreliable, unrepresentative benchmark; do not base decisions off it. It is included only for completeness.
"""

I suppose this was taken from the Unladden Swallow list of benchmarks and completely misses the point of what pybench is all about: it's a benchmark to run performance tests for individual parts of CPython's VM implementation. It never was intended to be representative. The main purpose is to be able to tell whether an optimization in CPython has an impact on individual areas of the interpreter or not.

Thanks.

----------

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue15369>
_______________________________________