[CDRIVER-3368] Audit documentation to make it clear that reply bson_t's should be stack-allocated Created: 16/Sep/19 Updated: 12/Jan/24 Resolved: 12/Jan/24 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | docs, Docs Examples |
| Affects Version/s: | None |
| Fix Version/s: | 1.25.5 |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | Samantha Ritter (Inactive) | Assignee: | Adrian Dole |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Quarter: | FY24Q3 | ||||
| Case: | (copied to CRM) | ||||
| Description |
|
Background & Motivation C driver API which accepts a bson_t* reply expects the reply to be uninitialized. This is inconsistently documented. mongoc_collection_command_simple notes:
mongoc_database_command_simple notes:
mongoc_client_session_commit_transaction notes:
Scope |
| Comments |
| Comment by Githook User [ 12/Jan/24 ] |
|
Author: {'name': 'Adrian Dole', 'email': 'adrian@dole.tech', 'username': 'adriandole'}Message: More explicit documentation for bson_t out-params. Audit docs to find where bson_t *reply is actually required. Co-authored-by: Kevin Albertson <kevin.albertson@10gen.com> --------- Co-authored-by: Kevin Albertson <kevin.albertson@10gen.com> |