summaryrefslogtreecommitdiff
path: root/coverage
diff options
context:
space:
mode:
Diffstat (limited to 'coverage')
-rw-r--r--coverage/__init__.py2
-rw-r--r--coverage/control.py11
2 files changed, 9 insertions, 4 deletions
diff --git a/coverage/__init__.py b/coverage/__init__.py
index 100e0b7..c48e90e 100644
--- a/coverage/__init__.py
+++ b/coverage/__init__.py
@@ -9,7 +9,7 @@ __version__ = "3.3a1" # see detailed history in CHANGES.txt
__url__ = "http://nedbatchelder.com/code/coverage"
-from coverage.control import coverage, measure_process
+from coverage.control import coverage, process_startup
from coverage.data import CoverageData
from coverage.cmdline import main, CoverageScript
from coverage.misc import CoverageException
diff --git a/coverage/control.py b/coverage/control.py
index 4acef71..415df27 100644
--- a/coverage/control.py
+++ b/coverage/control.py
@@ -373,11 +373,16 @@ class coverage(object):
return info
-def measure_process():
- """Called at Python startup time to perhaps measure coverage.
+def process_startup():
+ """Call this at Python startup to perhaps measure coverage.
+
+ To invoke this when Python starts, you can create a .pth file in your
+ Python installation containing this::
+
+ import coverage; coverage.process_startup()
If the environment variable COVERAGE_PROCESS_START is defined, coverage
- measurement is started, and the value of the variable is the data file
+ measurement is started. The value of the variable is the data file
prefix to use.
"""