<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 21:17:49 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-3368] Audit documentation to make it clear that reply bson_t&apos;s should be stack-allocated</title>
                <link>https://jira.mongodb.org/browse/CDRIVER-3368</link>
                <project id="10030" key="CDRIVER">C Driver</project>
                    <description>&lt;p&gt;&lt;b&gt;Background &amp;amp; Motivation&lt;/b&gt;&lt;/p&gt;

&lt;p&gt;C driver API which accepts a &lt;tt&gt;bson_t* reply&lt;/tt&gt; expects the &lt;tt&gt;reply&lt;/tt&gt; to be uninitialized. This is inconsistently documented. &lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;http://mongoc.org/libmongoc/current/mongoc_collection_command_simple.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;mongoc_collection_command_simple&lt;/a&gt; notes: &lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;reply: A location to initialize a bson_t. This should be on the stack.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;&lt;a href=&quot;http://mongoc.org/libmongoc/current/mongoc_database_command_simple.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;mongoc_database_command_simple&lt;/a&gt; notes:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;reply: A location to store the commands first result document.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;&lt;a href=&quot;http://mongoc.org/libmongoc/current/mongoc_client_session_commit_transaction.html&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;mongoc_client_session_commit_transaction&lt;/a&gt; notes:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;reply: An optional uninitialized bson_t to receive the server reply, or NULL.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;&lt;b&gt;Scope&lt;/b&gt;&lt;br/&gt;
Audit the documentation for all API methods that take a &lt;tt&gt;bson_t* reply&lt;/tt&gt; and consistently document that the &lt;tt&gt;reply&lt;/tt&gt; must be uninitialized and cannot be the pointer returned by &lt;tt&gt;bson_new&lt;/tt&gt;.&lt;/p&gt;</description>
                <environment></environment>
        <key id="930166">CDRIVER-3368</key>
            <summary>Audit documentation to make it clear that reply bson_t&apos;s should be stack-allocated</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="4" iconUrl="https://jira.mongodb.org/images/icons/priorities/minor.svg">Minor - P4</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="13201">Fixed</resolution>
                                        <assignee username="adrian.dole@mongodb.com">Adrian Dole</assignee>
                                    <reporter username="samantha.ritter@mongodb.com">Samantha Ritter</reporter>
                        <labels>
                    </labels>
                <created>Mon, 16 Sep 2019 20:45:30 +0000</created>
                <updated>Fri, 12 Jan 2024 19:47:01 +0000</updated>
                            <resolved>Fri, 12 Jan 2024 19:47:01 +0000</resolved>
                                                    <fixVersion>1.25.5</fixVersion>
                                    <component>docs</component>
                    <component>Docs Examples</component>
                                        <votes>0</votes>
                                    <watches>3</watches>
                                                                                                                <comments>
                            <comment id="6008052" author="xgen-internal-githook" created="Fri, 12 Jan 2024 18:38:06 +0000"  >&lt;p&gt;Author: &lt;/p&gt;
{&apos;name&apos;: &apos;Adrian Dole&apos;, &apos;email&apos;: &apos;adrian@dole.tech&apos;, &apos;username&apos;: &apos;adriandole&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-3368&quot; title=&quot;Audit documentation to make it clear that reply bson_t&amp;#39;s should be stack-allocated&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-3368&quot;&gt;&lt;del&gt;CDRIVER-3368&lt;/del&gt;&lt;/a&gt; Consistent bson_t *reply documentation (#1459)&lt;/p&gt;

&lt;p&gt;More explicit documentation for bson_t out-params. Audit docs to find where bson_t *reply is actually required.&lt;/p&gt;

&lt;p&gt;Co-authored-by: Kevin Albertson &amp;lt;kevin.albertson@10gen.com&amp;gt;&lt;/p&gt;

&lt;p&gt;---------&lt;/p&gt;

&lt;p&gt;Co-authored-by: Kevin Albertson &amp;lt;kevin.albertson@10gen.com&amp;gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/da6db59c99873d0ca504820e2a68fc88013e4f26&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/da6db59c99873d0ca504820e2a68fc88013e4f26&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                                        </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                    <customfield id="customfield_13552" key="com.go2group.jira.plugin.crm:crm_generic_field">
                        <customfieldname>Case</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[[5002K00000glFSvQAM]]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                    <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_21553" key="com.atlassian.jira.plugin.system.customfieldtypes:labels">
                        <customfieldname>Quarter</customfieldname>
                        <customfieldvalues>
                                        <label>FY24Q3</label>
    
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hvffrr:</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>