<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Wed Feb 07 22:01:18 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>[CXX-1070] Confusing installation instructions</title>
                <link>https://jira.mongodb.org/browse/CXX-1070</link>
                <project id="11980" key="CXX">C++ Driver</project>
                    <description>&lt;p&gt;Copied from notes on a &lt;a href=&quot;https://stackoverflow.com/a/39875020/11800&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;Stackoverflow question&lt;/a&gt; so we don&apos;t lose track of it.&lt;/p&gt;

&lt;blockquote&gt;
&lt;p&gt;A couple notable issues:&lt;/p&gt;

&lt;p&gt;The tutorial points to a specific file to fetch via curl rather than pointing to the github repository and suggesting doing a clone. This is a recipe for being a bit out of date. If I tell my infrastructure to fetch release 3.0.1, it will happily do that forever, rather than updating. That said, it appears that compiling from git is fine.&lt;br/&gt;
A prerequisite is installing libmongoc. It sure looks like installing from standard ubuntu packages is enough, since that&apos;s what the referenced page says. But the mongocxx installer wants &amp;gt;=1.3.4. So installing from git is required.&lt;br/&gt;
It depends on libbson &amp;gt;= 1.3.4, which is later than the ubuntu 16.04 installed version. So installing that, too, from git is required.&lt;br/&gt;
Note that none of the git packages specify which branch or tag to request in order to get a production build. Looking at all the tags on master and picking the numerically largest with no &quot;rc&quot; in the name seems to work. A tag called &quot;release&quot; or &quot;current&quot; would be oh-so-kind.&lt;br/&gt;
The build (typing make) tries to do a make install of the subpackage EP_mnmlstc_core, and this fails. So the entire build apparently has to run as root.&lt;br/&gt;
The example at the end of the tutorial presents build instructions that assume that everything you&apos;ve done is somehow known to pkg-config, but the instructions never suggested how to make pkg-config aware of you. I just manually added cflags and ldflags. For me, that became this, although (warning) I&apos;m still chasing down some symbols.&lt;/p&gt;&lt;/blockquote&gt;

&lt;p&gt;I see these specific issues to address:&lt;/p&gt;

&lt;ol&gt;
	&lt;li&gt;We need to provide a stable git reference for use in installation instructions. &lt;b&gt;UPDATE&lt;/b&gt;: done&lt;/li&gt;
	&lt;li&gt;We need to provide guidance on installing the correct versions of libmongoc, such as a git reference for installation. &lt;b&gt;UPDATE&lt;/b&gt;: docs mention specific versions; opened &lt;a href=&quot;https://jira.mongodb.org/browse/CDRIVER-1904&quot; title=&quot;Provide a permalink for latest stable tarball&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CDRIVER-1904&quot;&gt;&lt;del&gt;CDRIVER-1904&lt;/del&gt;&lt;/a&gt; to request permalink for stable tarball&lt;/li&gt;
	&lt;li&gt;We need to document that the build (&quot;make&quot;) stage tries to install install EP_mnmlstic_core by default; if this requires &lt;tt&gt;sudo&lt;/tt&gt;  (if the install directory is not owned by root) we need to mention that.  (Separately, we should find a way to break those stages apart.) &lt;b&gt;UPDATE: done&lt;/b&gt;&lt;/li&gt;
	&lt;li&gt;We need to give better instructions on using pkg-config. &lt;b&gt;UPDATE&lt;/b&gt;: doc patch ready&lt;/li&gt;
&lt;/ol&gt;
</description>
                <environment></environment>
        <key id="321604">CXX-1070</key>
            <summary>Confusing installation instructions</summary>
                <type id="1" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14703&amp;avatarType=issuetype">Bug</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="9">Done</resolution>
                                        <assignee username="david.golden@mongodb.com">David Golden</assignee>
                                    <reporter username="david.golden@mongodb.com">David Golden</reporter>
                        <labels>
                    </labels>
                <created>Thu, 6 Oct 2016 15:27:42 +0000</created>
                <updated>Tue, 13 Dec 2016 16:49:28 +0000</updated>
                            <resolved>Tue, 8 Nov 2016 14:54:03 +0000</resolved>
                                                    <fixVersion>3.1.0</fixVersion>
                                    <component>Documentation</component>
                                        <votes>1</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="1429317" author="xgen-internal-githook" created="Tue, 8 Nov 2016 16:25:09 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1070&quot; title=&quot;Confusing installation instructions&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1070&quot;&gt;&lt;del&gt;CXX-1070&lt;/del&gt;&lt;/a&gt; Improve installation instructions&lt;/p&gt;

&lt;p&gt;Adds git download instructions pointing to release branches.  Also&lt;br/&gt;
reminds people to be in &apos;build&apos; and remember &apos;..&apos;.&lt;br/&gt;
Branch: 3.1-dev&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/041cf76edebe3765d5d31ca47a40c9b5752b7fdc&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/041cf76edebe3765d5d31ca47a40c9b5752b7fdc&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1429316" author="xgen-internal-githook" created="Tue, 8 Nov 2016 16:25:08 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1070&quot; title=&quot;Confusing installation instructions&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1070&quot;&gt;&lt;del&gt;CXX-1070&lt;/del&gt;&lt;/a&gt; Explain how to compile with/without pkg-config&lt;br/&gt;
Branch: 3.1-dev&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/ade5d930f0f34ad1d6546c3001cf4fd047e387d2&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/ade5d930f0f34ad1d6546c3001cf4fd047e387d2&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1429182" author="david.golden" created="Tue, 8 Nov 2016 14:55:30 +0000"  >&lt;p&gt;Note: Doc update is now live on &lt;a href=&quot;https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1429180" author="david.golden" created="Tue, 8 Nov 2016 14:54:03 +0000"  >&lt;p&gt;We&apos;ve improved the docs in several ways to address the original posters concerns.&lt;/p&gt;</comment>
                            <comment id="1429179" author="xgen-internal-githook" created="Tue, 8 Nov 2016 14:52:29 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1070&quot; title=&quot;Confusing installation instructions&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1070&quot;&gt;&lt;del&gt;CXX-1070&lt;/del&gt;&lt;/a&gt; Improve installation instructions&lt;/p&gt;

&lt;p&gt;Adds git download instructions pointing to release branches.  Also&lt;br/&gt;
reminds people to be in &apos;build&apos; and remember &apos;..&apos;.&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/041cf76edebe3765d5d31ca47a40c9b5752b7fdc&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/041cf76edebe3765d5d31ca47a40c9b5752b7fdc&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1426738" author="xgen-internal-githook" created="Fri, 4 Nov 2016 20:39:35 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{u&apos;username&apos;: u&apos;xdg&apos;, u&apos;name&apos;: u&apos;David Golden&apos;, u&apos;email&apos;: u&apos;xdg@xdg.me&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/CXX-1070&quot; title=&quot;Confusing installation instructions&quot; class=&quot;issue-link&quot; data-issue-key=&quot;CXX-1070&quot;&gt;&lt;del&gt;CXX-1070&lt;/del&gt;&lt;/a&gt; Explain how to compile with/without pkg-config&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/ade5d930f0f34ad1d6546c3001cf4fd047e387d2&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-cxx-driver/commit/ade5d930f0f34ad1d6546c3001cf4fd047e387d2&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1425733" author="david.golden" created="Thu, 3 Nov 2016 22:12:10 +0000"  >&lt;p&gt;Moved to 3.1-desired as we won&apos;t actually be closing this ticket until after 3.0.3 ships.&lt;/p&gt;</comment>
                            <comment id="1425732" author="david.golden" created="Thu, 3 Nov 2016 22:10:57 +0000"  >&lt;p&gt;I have commit to merge after 3.0.3 ships that gives some additional advice around doing without pkg-config.  A draft is here: &lt;a href=&quot;https://gist.github.com/xdg/bb201a464d1de69cda90b0870a2c371b&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://gist.github.com/xdg/bb201a464d1de69cda90b0870a2c371b&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="1425715" author="david.golden" created="Thu, 3 Nov 2016 21:54:47 +0000"  >&lt;p&gt;&lt;tt&gt;releases/stable&lt;/tt&gt; will be created when we ship 3.0.3.   We need to add it to the release notes, installation notes and release process description.&lt;/p&gt;</comment>
                            <comment id="1411655" author="david.golden" created="Tue, 18 Oct 2016 16:41:00 +0000"  >&lt;p&gt;Updated manual page on &lt;a href=&quot;https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;installation&lt;/a&gt; to describe separate sudo install of mnmlstc in &lt;a href=&quot;https://github.com/mongodb/mongo-cxx-driver/commit/21ea8157aa1e29bccbe4f4937c1ad1d093d3fb3b#diff-568c5327976a53a5522e231c1cc89755R103&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;commit 21ea815&lt;/a&gt;.&lt;/p&gt;</comment>
                            <comment id="1407525" author="david.golden" created="Thu, 13 Oct 2016 15:36:23 +0000"  >&lt;p&gt;For stable references, I suggest creating the following branches:&lt;/p&gt;

&lt;ul&gt;
	&lt;li&gt;&lt;tt&gt;releases/stable&lt;/tt&gt; @ r3.0.2&lt;/li&gt;
	&lt;li&gt;&lt;tt&gt;releases/legacy&lt;/tt&gt; @ legacy-1.1.2&lt;/li&gt;
&lt;/ul&gt;


&lt;p&gt;When we release 3.1.0-beta1 or 3.1.0-rc0, we can add a branch there as &lt;tt&gt;releases/unstable&lt;/tt&gt; (or other term).&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|hrdiov:</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>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="1351">Perl/CXX 2016-11-11</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>