[SERVER-43317] Update failPoint documentation Created: 13/Sep/19  Updated: 29/Oct/23  Resolved: 04/Oct/19

Status: Closed
Project: Core Server
Component/s: Internal Code
Affects Version/s: None
Fix Version/s: 4.3.1

Type: Improvement Priority: Minor - P4
Reporter: A. Jesse Jiryu Davis Assignee: Billy Donahue
Resolution: Fixed Votes: 2
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
Problem/Incident
is caused by SERVER-43119 FailPoint API can be significantly im... Closed
Backwards Compatibility: Fully Compatible
Backport Requested:
v4.2
Sprint: Dev Tools 2019-10-21
Participants:

 Description   

After SERVER-43119, our failpoints documentation is out of date.

1. On the Internal wiki page, references to MONGO_FAIL_POINT_PAUSE_WHILE_SET and MONGO_FAIL_POINT_BLOCK should be updated, those macros are gone now.

2. A comment in curop_failpoint_helpers.h mentions MONGO_FAIL_POINT_PAUSE_WHILE_SET.

3. Instructions for using fail points is spread across fail_point.h and fail_point_service.h



 Comments   
Comment by Githook User [ 03/Oct/19 ]

Author:

{'name': 'Billy Donahue', 'username': 'BillyDonahue', 'email': 'billy.donahue@mongodb.com'}

Message: SERVER-43317 merge failpoint headers. Rewrite docs.

iterate docs
Branch: master
https://github.com/mongodb/mongo/commit/8ccaacce937ae51deef27c41e977aca0511fb338

Comment by Billy Donahue [ 30/Sep/19 ]

I addressed the wiki issue.

Merging headers etc in https://mongodbcr.appspot.com/507200001/

Generated at Thu Feb 08 05:02:51 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.