[CDRIVER-3903] Documentation contradictory information Created: 08/Feb/21 Updated: 27/Oct/23 Resolved: 08/Feb/21 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Bug | Priority: | Major - P3 |
| Reporter: | Fermín Galán | Assignee: | Clyde Bazile III (Inactive) |
| Resolution: | Works as Designed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Description |
|
The recommendation for -DENABLE_AUTOMATIC_INIT_AND_CLEANUP differs in the documentation. In particular:
Which one is the right one? NO? OFF? Both? I understand documentation should be consistent and show always the same option. |
| Comments |
| Comment by Fermín Galán [ 08/Feb/21 ] |
|
Thanks for the clarification. I have created this pull request to make documentation homogeneous, using OFF all the time: https://github.com/mongodb/mongo-c-driver/pull/735. I hope you find it useful. |
| Comment by Clyde Bazile III (Inactive) [ 08/Feb/21 ] |
|
Hi fermin.galanmarquez@telefonica.com, thanks for pointing this out. Both NO and OFF are valid. According to CMake's documentation (here), 0, OFF, NO, FALSE, etc., will all evaluate to false. |