<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 21:14:14 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[CDRIVER-2121] Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation</title>
                <link>https://jira.mongodb.org/browse/CDRIVER-2121</link>
                <project id="10030" key="CDRIVER">C Driver</project>
                    <description>&lt;p&gt;The documentation for &lt;a href=&quot;http://mongoc.org/libmongoc/current/mongoc_client_set_ssl_opts.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;mongoc_client_set_ssl_opts()&lt;/a&gt; suffers from a couple of issues:&lt;/p&gt;
&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
	&lt;li&gt;The function signature is missing the function&apos;s return type (void).&lt;/li&gt;
	&lt;li&gt;The discussion of the parameter &lt;tt&gt;opts&lt;/tt&gt; contains two contradictory statements regarding its lifetime requirements.  One of these should be removed:
	&lt;ul class=&quot;alternate&quot; type=&quot;square&quot;&gt;
		&lt;li&gt;&quot;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&apos;t have to remain valid after the call to mongoc_client_set_ssl_opts.&quot;&lt;/li&gt;
		&lt;li&gt;&quot;opts: A mongoc_ssl_opt_t. The struct is copied by the client, but the strings it points to are not.&quot;&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;I also suggest that the discussion of the lifetime requirement of &lt;tt&gt;opts&lt;/tt&gt; be copied over to the documentation for &lt;a href=&quot;http://mongoc.org/libmongoc/current/mongoc_client_pool_set_ssl_opts.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;mongoc_client_pool_set_ssl_opts()&lt;/a&gt;.&lt;/p&gt;</description>
                <environment></environment>
        <key id="371615">CDRIVER-2121</key>
            <summary>Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation</summary>
                <type id="1" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14703&amp;avatarType=issuetype">Bug</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="9">Done</resolution>
                                        <assignee username="bjori">Hannes Magnusson</assignee>
                                    <reporter username="rassi">J Rassi</reporter>
                        <labels>
                    </labels>
                <created>Thu, 6 Apr 2017 17:19:35 +0000</created>
                <updated>Mon, 17 Apr 2017 15:42:08 +0000</updated>
                            <resolved>Fri, 7 Apr 2017 16:12:47 +0000</resolved>
                                                                    <component>docs</component>
                                        <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="1543886" author="xgen-internal-githook" created="Fri, 7 Apr 2017 17:58:41 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;ajdavis&apos;, u&apos;name&apos;: u&apos;A. Jesse Jiryu Davis&apos;, u&apos;email&apos;: u&apos;jesse@mongodb.com&apos;}
&lt;p&gt;Message: Merge remote-tracking branch &apos;upstream/master&apos;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;upstream/master:&lt;br/&gt;
  Fix typo&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Remove legacy info&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Update set_ssl_opts since &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1316&quot; title=&quot;Copy strings referred by mongoc_ssl_opts_t&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1316&quot;&gt;&lt;del&gt;CDRIVER-1316&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2120&quot; title=&quot;Add MONGOC_TEST_COMPRESSORS to test suite&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2120&quot;&gt;&lt;del&gt;CDRIVER-2120&lt;/del&gt;&lt;/a&gt; Add MONGOC_TEST_COMPRESSORS to the test suite&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/9d8d916b5feb04eac34854f71f555936aefbfb91&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/9d8d916b5feb04eac34854f71f555936aefbfb91&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="1543885" author="xgen-internal-githook" created="Fri, 7 Apr 2017 17:58:40 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;ajdavis&apos;, u&apos;name&apos;: u&apos;A. Jesse Jiryu Davis&apos;, u&apos;email&apos;: u&apos;jesse@mongodb.com&apos;}
&lt;p&gt;Message: Merge remote-tracking branch &apos;upstream/master&apos;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;upstream/master:&lt;br/&gt;
  Fix typo&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Remove legacy info&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Update set_ssl_opts since &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1316&quot; title=&quot;Copy strings referred by mongoc_ssl_opts_t&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1316&quot;&gt;&lt;del&gt;CDRIVER-1316&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
  &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2120&quot; title=&quot;Add MONGOC_TEST_COMPRESSORS to test suite&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2120&quot;&gt;&lt;del&gt;CDRIVER-2120&lt;/del&gt;&lt;/a&gt; Add MONGOC_TEST_COMPRESSORS to the test suite&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/9d8d916b5feb04eac34854f71f555936aefbfb91&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/9d8d916b5feb04eac34854f71f555936aefbfb91&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
</comment>
                            <comment id="1543752" author="xgen-internal-githook" created="Fri, 7 Apr 2017 16:12:25 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;bjori&apos;, u&apos;name&apos;: u&apos;Hannes Magnusson&apos;, u&apos;email&apos;: u&apos;bjori@php.net&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Remove legacy info&lt;/p&gt;

&lt;p&gt;Historic details can be found in the published legacy docs&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/185f7efbc5db46bf6b82fe5276c067521c2f2ea0&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/185f7efbc5db46bf6b82fe5276c067521c2f2ea0&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1543750" author="xgen-internal-githook" created="Fri, 7 Apr 2017 16:12:23 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;bjori&apos;, u&apos;name&apos;: u&apos;Hannes Magnusson&apos;, u&apos;email&apos;: u&apos;bjori@php.net&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-2121&quot; title=&quot;Missing return type and contradictory parameter information in mongoc_client_set_ssl_opts() documentation&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-2121&quot;&gt;&lt;del&gt;CDRIVER-2121&lt;/del&gt;&lt;/a&gt; Update set_ssl_opts since &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1316&quot; title=&quot;Copy strings referred by mongoc_ssl_opts_t&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1316&quot;&gt;&lt;del&gt;CDRIVER-1316&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/0f53bcffe6bd04d680ef37d74dab7c0c5b1080db&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/0f53bcffe6bd04d680ef37d74dab7c0c5b1080db&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hsxr4n:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>