[Python-checkins] devguide: Add a paragraph about checking for refleaks. Initial patch by Daniel Shahaf.

Fri Jan 11 12:41:02 CET 2013

http://hg.python.org/devguide/rev/de93193d7a33
changeset: 590:de93193d7a33
user: Ezio Melotti <ezio.melotti at gmail.com>
date: Fri Jan 11 13:40:53 2013 +0200
summary:
 Add a paragraph about checking for refleaks. Initial patch by Daniel Shahaf.
files:
 committing.rst | 1 +
 runtests.rst | 5 +++++
 2 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/committing.rst b/committing.rst
--- a/committing.rst
+++ b/committing.rst
@@ -35,6 +35,7 @@
 * Has ``configure`` been regenerated, if necessary?
 * Has ``pyconfig.h.in`` been regenerated, if necessary?
 * Has the test suite been run?
+* Are there any reference leaks?
 
 Note that the automated patch check can't actually *answer* all of these
 questions, and even if it could, it still wouldn't know whether or not
diff --git a/runtests.rst b/runtests.rst
--- a/runtests.rst
+++ b/runtests.rst
@@ -71,6 +71,11 @@
 The ``-uall`` flag allows the use of all available
 resources so as to not skip tests requiring, e.g., Internet access.
 
+To check for reference leaks (only needed if you modified C code), use the
+``-R`` flag. For example, ``-R 3:2`` will first run the test 3 times to settle
+down the reference count, and then run it 2 more times to verify if there are
+any leaks.
+
 You can also execute the ``Tools/scripts/run_tests.py`` script as found in a
 CPython checkout. The script tries to balance speed with thoroughness. But if
 you want the most thorough tests you should use the strenuous approach shown
-- 
Repository URL: http://hg.python.org/devguide
