diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2022-05-18 07:18:51 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2022-05-18 07:18:51 -0400 |
| commit | 803a5494ef23187e920eeb4b42e922b87cda5966 (patch) | |
| tree | 141923268aef69c8b66324977160f60a7b1e7b24 /doc | |
| parent | cde33ba4ded948bfc1fc9c6768db35d7728102c2 (diff) | |
| download | python-coveragepy-git-803a5494ef23187e920eeb4b42e922b87cda5966.tar.gz | |
fix: the SIGTERM handler is now opt-in. #1310
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst index be23dbdf..70f56c0e 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -268,6 +268,24 @@ need to know the source origin. .. versionadded:: 5.0 +.. _config_run_sigterm: + +[run] sigterm +............. + +(boolean, default False) if true, register a SIGTERM signal handler to capture +data when the process ends due to a SIGTERM signal. This includes +:meth:`Process.terminate <python:multiprocessing.Process.terminate>`, and other +ways to terminate a process. This can help when collecting data in usual +situations, but can also introduce problems (see `issue 1310`_). + +Only on Linux and Mac. + +.. _issue 1310: https://github.com/nedbat/coveragepy/issues/1310 + +.. versionadded:: 6.4 (in 6.3 this was always enabled) + + .. _config_run_source: [run] source |