[CDRIVER-2121] Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation Created: 06/Apr/17  Updated: 17/Apr/17  Resolved: 07/Apr/17

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Major - P3
Reporter: J Rassi Assignee: Hannes Magnusson
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The documentation for mongoc_client_set_ssl_opts() suffers from a couple of issues:

  • The function signature is missing the function's return type (void).
  • The discussion of the parameter opts contains two contradictory statements regarding its lifetime requirements. One of these should be removed:
    • "The mongoc_ssl_opt_t struct is copied by the client along with the strings it points to (pem_file, pem_pwd, ca_file, ca_dir, and crl_file) so they don't have to remain valid after the call to mongoc_client_set_ssl_opts."
    • "opts: A mongoc_ssl_opt_t. The struct is copied by the client, but the strings it points to are not."

I also suggest that the discussion of the lifetime requirement of opts be copied over to the documentation for mongoc_client_pool_set_ssl_opts().



 Comments   
Comment by Githook User [ 07/Apr/17 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge remote-tracking branch 'upstream/master'

Comment by Githook User [ 07/Apr/17 ]

Author:

{u'username': u'ajdavis', u'name': u'A. Jesse Jiryu Davis', u'email': u'jesse@mongodb.com'}

Message: Merge remote-tracking branch 'upstream/master'

Comment by Githook User [ 07/Apr/17 ]

Author:

{u'username': u'bjori', u'name': u'Hannes Magnusson', u'email': u'bjori@php.net'}

Message: CDRIVER-2121 Remove legacy info

Historic details can be found in the published legacy docs
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/185f7efbc5db46bf6b82fe5276c067521c2f2ea0

Comment by Githook User [ 07/Apr/17 ]

Author:

{u'username': u'bjori', u'name': u'Hannes Magnusson', u'email': u'bjori@php.net'}

Message: CDRIVER-2121 Update set_ssl_opts since CDRIVER-1316
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/0f53bcffe6bd04d680ef37d74dab7c0c5b1080db

Generated at Wed Feb 07 21:14:14 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.