Skip to content

Commit

Permalink
Update hugo files
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinAlbs committed Nov 8, 2023
1 parent 6f65f45 commit b3655c7
Show file tree
Hide file tree
Showing 8 changed files with 81 additions and 21 deletions.
8 changes: 4 additions & 4 deletions contributing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1770,9 +1770,9 @@ <h3 id="headers">Headers</h3>
<li>System Headers <code>&lt;vector&gt;</code> (alphabetical order)</li>
<li>Driver Headers <code>&lt;path/to/header.hpp&gt;</code> (alphabetical order)</li>
<li>Open Namespace mongocxx</li>
<li><code>MONGOCXX_INLINE_NAMESPACE_BEGIN</code></li>
<li><code>inline namespace v_noabi {</code></li>
<li>Code</li>
<li><code>MONGOCXX_INLINE_NAMESPACE_END</code></li>
<li><code>} // namespace v_noabi</code></li>
<li>Close Namespace mongocxx</li>
<li>Header Postlude</li>
</ul>
Expand Down Expand Up @@ -1800,13 +1800,13 @@ <h3 id="headers">Headers</h3>
#include &lt;driver/blah.hpp&gt;

namespace mongocxx {
MONGOCXX_INLINE_NAMESPACE_BEGIN
inline namespace v_noabi {

// Declarations

// Inline Implementations

MONGOCXX_INLINE_NAMESPACE_END
} // namespace v_noabi
} // namespace mongocxx

#include &lt;driver/config/postlude.hpp&gt;
Expand Down
10 changes: 8 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta name="generator" content="Hugo 0.119.0">
<meta name="generator" content="Hugo 0.117.0">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
Expand Down Expand Up @@ -1710,12 +1710,18 @@ <h2 id="driver-status-by-family-and-version">Driver status by family and version
<td>New feature development</td>
</tr>
<tr>
<td>mongocxx 3.8.x</td>
<td>mongocxx 3.9.x</td>
<td>Stable</td>
<td>Bug fixes only</td>
<td>Current stable C++ driver release</td>
</tr>
<tr>
<td>mongocxx 3.8.x</td>
<td>Stable</td>
<td>None</td>
<td>Previous stable C++ driver release</td>
</tr>
<tr>
<td>mongocxx 3.7.x</td>
<td>Stable</td>
<td>None</td>
Expand Down
2 changes: 1 addition & 1 deletion legacy-v1/tutorial/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1600,7 +1600,7 @@ <h4 id="dbclientconnection">DBClientConnection</h4>
<h4 id="a-simple-program-that-connects-to-the-database">A simple program that connects to the database</h4>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-cpp" data-lang="cpp"><span style="display:flex;"><span><span style="color:#75715e">#include</span> <span style="color:#75715e">&lt;cstdlib&gt;</span><span style="color:#75715e">
</span></span></span><span style="display:flex;"><span><span style="color:#75715e">#include</span> <span style="color:#75715e">&lt;iostream&gt;</span><span style="color:#75715e">
</span></span></span><span style="display:flex;"><span><span style="color:#75715e">#include</span> <span style="color:#75715e">&#34;mongo/client/dbclient.h&#34;</span><span style="color:#75715e"> </span><span style="color:#75715e">// for the driver
</span></span></span><span style="display:flex;"><span><span style="color:#75715e">#include</span> <span style="color:#75715e">&#34;mongo/client/dbclient.h&#34; // for the driver</span><span style="color:#75715e">
</span></span></span><span style="display:flex;"><span><span style="color:#75715e"></span>
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">void</span> <span style="color:#a6e22e">run</span>() {
</span></span><span style="display:flex;"><span> mongo<span style="color:#f92672">::</span>DBClientConnection c;
Expand Down
3 changes: 2 additions & 1 deletion mongocxx-v3/installation/advanced/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1312,9 +1312,10 @@ <h2 id="additional-options-for-integrators">Additional Options for Integrators</
</span></span></code></pre></div><p>The above command would produce libraries named <code>libcustom_bsoncxx.so</code> and <code>libcustom_mongocxx.so</code> (or with the extension appropriate for the build platform). Those libraries could be placed in a standard system directory or in an alternate location and could be linked to by specifying something like <code>-lcustom_mongocxx -lcustom_bsoncxx</code> on the linker command line (possibly adjusting the specific flags to those required by your linker).</p>
<h2 id="installing-the-mongodb-c-driver">Installing the MongoDB C driver.</h2>
<p>The mongocxx driver builds on top of the <a href="https://www.mongodb.com/docs/drivers/c/">MongoDB C driver</a>.</p>
<p>The build of mongocxx-3.8.1 automatically downloads and installs the C driver if the C driver is not detected.
<p>The build of mongocxx-3.9.0 automatically downloads and installs the C driver if the C driver is not detected.
To use an existing install of the C driver, set <code>CMAKE_PREFIX_PATH</code> to the directory containing the C driver install.</p>
<ul>
<li>For mongocxx-3.9.x, libmongoc 1.25.0 or later is required.</li>
<li>For mongocxx-3.8.x, libmongoc 1.24.0 or later is required.</li>
<li>For mongocxx-3.7.x, libmongoc 1.22.1 or later is required.</li>
<li>For mongocxx-3.6.x, libmongoc 1.17.0 or later is required.</li>
Expand Down
55 changes: 54 additions & 1 deletion mongocxx-v3/installation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1228,8 +1228,61 @@ <h2 id="package-managers">Package Managers</h2>
<ul>
<li><a href="https://vcpkg.io/">Vcpkg</a> (search for mongo-cxx-driver)</li>
<li><a href="https://conan.io/center/recipes/mongo-cxx-driver">Conan</a></li>
<li><a href="https://formulae.brew.sh/formula/mongo-cxx-driver">Homebrew</a></li>
</ul>
<h2 id="docker-image">Docker Image</h2>
<h3 id="vcpkg-install-instructions">Vcpkg Install Instructions</h3>
<p>If you do not already have Vcpkg installed, install it with the following
command:</p>
<pre tabindex="0"><code>$ git clone https://github.com/Microsoft/vcpkg.git
$ cd vcpkg
$ ./bootstrap-vcpkg.sh
</code></pre><p>Optionally, to install with Visual Studio integration:</p>
<pre tabindex="0"><code>vcpkg integrate install
</code></pre><p>Install the driver. (You may need to <code>git pull</code> to get the latest version of the
driver)</p>
<pre tabindex="0"><code>$ ./vcpkg install mongo-cxx-driver
</code></pre><p>You can use the toolchain file, <code>vcpkg.cmake</code>, to instruct CMake where to find
the development files, for example:</p>
<pre tabindex="0"><code>-DCMAKE_TOOLCHAIN_FILE=/&lt;path to vcpkg repo&gt;/vcpkg/scripts/buildsystems/vcpkg.cmake
</code></pre><p>You can find the header files in:</p>
<pre tabindex="0"><code>vcpkg/installed/&lt;CPU ARCHITECTURE&gt;-&lt;OPERATING SYSTEM&gt;/include/
</code></pre><p>The library files are in:</p>
<pre tabindex="0"><code>vcpkg/installed/&lt;CPU ARCHITECTURE&gt;-&lt;OPERATING SYSTEM&gt;/lib/
</code></pre><h3 id="conan-install-instructions">Conan Install Instructions</h3>
<p>Package Specifier: <code>mongo-cxx-driver/3.8.0</code></p>
<p>If you do not already have Conan installed, then install it and run the Conan
initalization command below:</p>
<pre tabindex="0"><code>$ pip install conan
$ conan profile detect --force
</code></pre><p>Add the following to your <code>conanfile.txt</code></p>
<pre tabindex="0"><code>[requires]
mongo-cxx-driver/3.8.0
[generators]
CMakeDeps
CMakeToolchain
</code></pre><p>Install the driver via Conan, and build your project:</p>
<pre tabindex="0"><code>$ conan install conanfile.txt --output-folder=build --build=missing
$ cmake \
-B build \
-DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake \
-DCMAKE_BUILD_TYPE=Release
$ cmake --build build
</code></pre><h3 id="homebrew">Homebrew</h3>
<p>For MacOS users, homebrew is a convienent way to install the C++ driver.</p>
<pre tabindex="0"><code>brew install mongo-cxx-driver
</code></pre><h4 id="for-an-apple-silicon-mac">For an Apple Silicon Mac</h4>
<p>Headers can be found in:</p>
<pre tabindex="0"><code>/opt/homebrew/include/mongocxx/v_noabi/
/opt/homebrew/include/bsoncxx/v_noabi/
</code></pre><p>Library files can be found in:</p>
<pre tabindex="0"><code>/opt/homebrew/lib/
</code></pre><h4 id="for-an-intel-mac">For an Intel Mac</h4>
<p>Headers can be found in:</p>
<pre tabindex="0"><code>/usr/local/include/mongocxx/v_noabi/
/usr/local/include/bsoncxx/v_noabi/
</code></pre><p>Library files can be found in:</p>
<pre tabindex="0"><code>/usr/local/lib/
</code></pre><h2 id="docker-image">Docker Image</h2>
<p>You can find a pre-built docker image for the C++ driver in
<a href="https://hub.docker.com/r/mongodb/mongo-cxx-driver">Docker Hub</a>.</p>

Expand Down
8 changes: 4 additions & 4 deletions mongocxx-v3/installation/linux/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1314,10 +1314,10 @@ <h3 id="step-2-download-the-latest-version-of-the-mongocxx-driver">Step 2: Downl
release tarball.</p>
<p>The <a href="https://github.com/mongodb/mongo-cxx-driver/releases">mongocxx releases</a>
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.8.1:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.8.1/mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.8.1/build
example, to download version 3.9.0:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.9.0/build
</span></span></code></pre></div><p>Make sure you change to the <code>build</code> directory of whatever source tree you
obtain.</p>
<h3 id="step-3-configure-the-driver">Step 3: Configure the driver</h3>
Expand Down
8 changes: 4 additions & 4 deletions mongocxx-v3/installation/macos/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1290,10 +1290,10 @@ <h3 id="step-2-download-the-latest-version-of-the-mongocxx-driver">Step 2: Downl
release tarball.</p>
<p>The <a href="https://github.com/mongodb/mongo-cxx-driver/releases">mongocxx releases</a>
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.8.1:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.8.1/mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.8.1/build
example, to download version 3.9.0:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.9.0/build
</span></span></code></pre></div><p>Make sure you change to the <code>build</code> directory of whatever source tree you
obtain.</p>
<h3 id="step-3-configure-the-driver">Step 3: Configure the driver</h3>
Expand Down
8 changes: 4 additions & 4 deletions mongocxx-v3/installation/windows/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1266,10 +1266,10 @@ <h3 id="step-2-download-the-latest-version-of-the-mongocxx-driver">Step 2: Downl
release tarball.</p>
<p>The <a href="https://github.com/mongodb/mongo-cxx-driver/releases">mongocxx releases</a>
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.8.1:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.8.1/mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.8.1.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.8.1/build
example, to download version 3.9.0:</p>
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
</span></span><span style="display:flex;"><span>cd mongo-cxx-driver-r3.9.0/build
</span></span></code></pre></div><p>Make sure you change to the <code>build</code> directory of whatever source tree you
obtain.</p>
<h3 id="step-3-configure-the-driver">Step 3: Configure the driver</h3>
Expand Down

0 comments on commit b3655c7

Please sign in to comment.