From dee725b05332ca59a679c7b7dde5297c502d34b4 Mon Sep 17 00:00:00 2001 From: Krystian Kuzniarek Date: Mon, 11 Nov 2019 17:17:52 +0100 Subject: [PATCH] add documentation for the premature-exit-file protocol --- googletest/docs/advanced.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/googletest/docs/advanced.md b/googletest/docs/advanced.md index ce8644e4..217d527a 100644 --- a/googletest/docs/advanced.md +++ b/googletest/docs/advanced.md @@ -2541,6 +2541,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