<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 21:18:03 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-3441] Document mongoc_handshake_data_append</title>
                <link>https://jira.mongodb.org/browse/CDRIVER-3441</link>
                <project id="10030" key="CDRIVER">C Driver</project>
                    <description></description>
                <environment></environment>
        <key id="1030546">CDRIVER-3441</key>
            <summary>Document mongoc_handshake_data_append</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</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="jesse.williamson@mongodb.com">Jesse Williamson</assignee>
                                    <reporter username="rathi.gnanasekaran">Rathi Gnanasekaran</reporter>
                        <labels>
                    </labels>
                <created>Mon, 2 Dec 2019 15:46:54 +0000</created>
                <updated>Mon, 13 Sep 2021 19:29:00 +0000</updated>
                            <resolved>Mon, 13 Sep 2021 19:29:00 +0000</resolved>
                                                                                        <votes>0</votes>
                                    <watches>4</watches>
                                                                                                                <comments>
                            <comment id="4053878" author="xgen-internal-githook" created="Mon, 13 Sep 2021 16:03:20 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Jesse Williamson&apos;, &apos;email&apos;: &apos;jesse.williamson@mongodb.com&apos;, &apos;username&apos;: &apos;chardan&apos;}
&lt;p&gt;Message: Fix CDRIVER3441 - document mongoc_handshake_data_append and alias as &#8230; (#852)&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Fix CDRIVER3441 - document mongoc_handshake_data_append and alias as mongoc_add_driver_info&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;I took a slightly different tack on this and made the older form an alias to the preferred,&lt;br/&gt;
newer one.&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-3441&quot; class=&quot;external-link&quot; rel=&quot;nofollow&quot;&gt;https://jira.mongodb.org/browse/CDRIVER-3441&lt;/a&gt;&lt;/p&gt;

&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add Sphinx documentation.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Move inline documentation out of source.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add test showing that forwarding function can be called.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Revert renaming and forwarding function.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Update documentation: this is not deprecated, we will be offering an&lt;br/&gt;
alternative.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Add mongoc_handshake_data_append into the TOC/document structure.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Update mongoc_handshake_data_append documentation to more accurately describe&lt;br/&gt;
server monitoring and initiation. Some cosmetic adjustments.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;Update example responses to reflect current behavior.&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;Signed-off-by: Jesse Williamson &amp;lt;jesse.williamson@mongodb.com&amp;gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/commit/4835c38aafa6d8954321f93f49a6458756e66053&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/commit/4835c38aafa6d8954321f93f49a6458756e66053&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4044721" author="kevin.albertson" created="Wed, 8 Sep 2021 13:47:11 +0000"  >&lt;p&gt;Given the likliehood that &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-4142&quot; title=&quot;Use separate handshake metadata for clients&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-4142&quot;&gt;CDRIVER-4142&lt;/a&gt; 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 &lt;tt&gt;mongoc_handshake_data_append&lt;/tt&gt; and not introducing a new alias.&lt;/p&gt;</comment>
                            <comment id="4030069" author="JIRAUSER1261121" created="Mon, 30 Aug 2021 20:12:58 +0000"  >&lt;p&gt;&lt;a href=&quot;https://github.com/mongodb/mongo-c-driver/pull/852&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-c-driver/pull/852&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="4020510" author="JIRAUSER1261121" created="Tue, 24 Aug 2021 21:44:41 +0000"  >&lt;p&gt;On a related (but not entirely germane) note: have we considered a publicly available maintainence interface? &lt;/p&gt;

&lt;p&gt;int mongoc_reserved_maint(void *in_ctx, void *out_ctx);&lt;/p&gt;

&lt;p&gt;...which is publicly available and documented, but reserved for internal use rather than for user calls. In practice,&lt;br/&gt;
this could take a struct with data and function pointers, and optionally return values.&lt;/p&gt;</comment>
                            <comment id="4020498" author="JIRAUSER1261121" created="Tue, 24 Aug 2021 21:41:19 +0000"  >&lt;p&gt;Since this is &quot;public but undocumented&quot;, 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&apos;t like having their program suddenly fail to link, but also aliases&lt;br/&gt;
of things intentionally undocumented... feels extremely itchy.&lt;/p&gt;

&lt;p&gt;Note: seeing that this has been around since 2016, I&apos;m inclined to say we shouldn&apos;t break it. But as this will be our &quot;last chance&quot; to do so, it&apos;s probably still worth talking about.&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10011">
                    <name>Depends</name>
                                                                <inwardlinks description="is depended on by">
                                        <issuelink>
            <issuekey id="1011709">CXX-1881</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="1864027">CDRIVER-4142</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="1011714">CDRIVER-3434</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <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|hvvbvr:</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>