Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-2121

Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation

    XMLWordPrintableJSON

Details

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Major - P3 Major - P3
    • None
    • None
    • docs
    • None

    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().

      Attachments

        Activity

          People

            bjori Hannes Magnusson
            rassi J Rassi
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: