aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndy Getz <durandal@google.com>2020-04-04 18:05:39 -0400
committerAndy Getz <durandal@google.com>2020-04-04 18:05:39 -0400
commite3f0319d89f4cbf32993de595d984183b1a9fc57 (patch)
tree81a29942cb8e8f559f65729dc09b28ee064674dd
parent7084afda5aa3d277177f11056c6e9776fd0a3d1c (diff)
parentdee725b05332ca59a679c7b7dde5297c502d34b4 (diff)
downloadgoogletest-e3f0319d89f4cbf32993de595d984183b1a9fc57.tar.gz
googletest-e3f0319d89f4cbf32993de595d984183b1a9fc57.tar.bz2
googletest-e3f0319d89f4cbf32993de595d984183b1a9fc57.zip
Merge pull request #2715 from kuzkry:document-premature-exit-file-protocol
PiperOrigin-RevId: 304617903
-rw-r--r--googletest/docs/advanced.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/googletest/docs/advanced.md b/googletest/docs/advanced.md
index 1295c9dd..d65f1eff 100644
--- a/googletest/docs/advanced.md
+++ b/googletest/docs/advanced.md
@@ -2562,6 +2562,18 @@ IMPORTANT: The exact format of the JSON document is subject to change.
### Controlling How Failures Are Reported
+#### Detecting Test Premature Exit
+
+Google Test implements the _premature-exit-file_ protocol for test runners
+to catch any kind of unexpected exits of test programs. Upon start,
+Google Test creates the file which will be automatically deleted after
+all work has been finished. Then, the test runner can check if this file
+exists. In case the file remains undeleted, the inspected test has exited
+prematurely.
+
+This feature is enabled only if the `TEST_PREMATURE_EXIT_FILE` environment
+variable has been set.
+
#### Turning Assertion Failures into Break-Points
When running test programs under a debugger, it's very convenient if the