[CDRIVER-3441] Document mongoc_handshake_data_append Created: 02/Dec/19 Updated: 13/Sep/21 Resolved: 13/Sep/21 |
|
| Status: | Closed |
| Project: | C Driver |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Task | Priority: | Major - P3 |
| Reporter: | Rathi Gnanasekaran | Assignee: | Jesse Williamson (Inactive) |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||
| Comments |
| Comment by Githook User [ 13/Sep/21 ] |
|
Author: {'name': 'Jesse Williamson', 'email': 'jesse.williamson@mongodb.com', 'username': 'chardan'}Message: Fix CDRIVER3441 - document mongoc_handshake_data_append and alias as … (#852)
I took a slightly different tack on this and made the older form an alias to the preferred, https://jira.mongodb.org/browse/CDRIVER-3441 Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com>
Signed-off-by: Jesse Williamson <jesse.williamson@mongodb.com> |
| Comment by Kevin Albertson [ 08/Sep/21 ] |
|
Given the likliehood that CDRIVER-4142 will introduce a new preferred way of setting handshake metadata at a client level, I am in favor of proceeding with only documenting the existing mongoc_handshake_data_append and not introducing a new alias. |
| Comment by Jesse Williamson (Inactive) [ 30/Aug/21 ] |
| Comment by Jesse Williamson (Inactive) [ 24/Aug/21 ] |
|
On a related (but not entirely germane) note: have we considered a publicly available maintainence interface? int mongoc_reserved_maint(void *in_ctx, void *out_ctx); ...which is publicly available and documented, but reserved for internal use rather than for user calls. In practice, |
| Comment by Jesse Williamson (Inactive) [ 24/Aug/21 ] |
|
Since this is "public but undocumented", should we also /consider/ renaming the function (which would potentially break external code, but not put us in the position of maintaining undocumented aliases)? I can see this both ways: people definitely don't like having their program suddenly fail to link, but also aliases Note: seeing that this has been around since 2016, I'm inclined to say we shouldn't break it. But as this will be our "last chance" to do so, it's probably still worth talking about. |