Skip to content

Commit

Permalink
Fix typo: equivalen -> equivalent
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffwidman authored and onsi committed Jan 29, 2022
1 parent 5e1988c commit 1a866a5
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/MIGRATING_TO_V2.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Interrupt behavior is substantially improved, sending an interrupt signal will n
Previously, sending a second interrupt signal would cause Ginkgo to exit immediately. With the improved interrupt behavior this is no longer necessary and Ginkgo will not exit until the test suite has unwound and completed.

### Timeout Behavior
In Ginkgo V1.x, Ginkgo's timeout was managed by `go test`. This meant that timeouts exited the test suite abruptly with no opportunity for custom reporters or clean up code (e.g. `AfterEach`, `AfterSuite`) to run. This is fixed in V2. Ginkgo now manages its own timeout and when a timeout triggers the test winds down gracefully. In fact, a timeout is now functionally equivalen to a user-initiated interrupt.
In Ginkgo V1.x, Ginkgo's timeout was managed by `go test`. This meant that timeouts exited the test suite abruptly with no opportunity for custom reporters or clean up code (e.g. `AfterEach`, `AfterSuite`) to run. This is fixed in V2. Ginkgo now manages its own timeout and when a timeout triggers the test winds down gracefully. In fact, a timeout is now functionally equivalent to a user-initiated interrupt.

In addition, in V1.x when running multiple test suites Ginkgo would give each suite the full timeout allotment (so `ginkgo -r -timeout=1h` would give _each_ test suite one hour to complete). In V2 the timeout now applies to the entire test suite run so that `ginkgo -r -timeout=1h` is now guaranteed to exit after (about) one hour.

Expand Down

0 comments on commit 1a866a5

Please sign in to comment.