Skip to content

CXX-2784 Update documentation for 3.10.0 #1105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 29, 2024
Merged

CXX-2784 Update documentation for 3.10.0 #1105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
226179b
Update CHANGELOG for 3.10.0
adriandole Feb 23, 2024
f8d062f
Prepare to generate r3.10.0 release documentation
adriandole Feb 23, 2024
41ce416
Correction: libmongoc version requirement is unchanged for 3.10
adriandole Feb 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Changes prior to 3.9.0 are documented as [release notes on GitHub](https://github.com/mongodb/mongo-cxx-driver/releases).

## 3.10.0 [Unreleased]
## 3.10.0

### Added

Expand Down
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ Currently, no drivers guarantee API or ABI stability.
| Family/version | Stability | Development | Purpose |
| -------------------- | ----------- | ------------------- | ----------------------------------- |
| (repo master branch) | Unstable | Active development | New feature development |
| mongocxx 3.9.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.10.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.9.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.8.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.7.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.6.x | Stable | None | Previous stable C++ driver release |
Expand Down
3 changes: 2 additions & 1 deletion docs/content/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ Currently, no drivers guarantee API or ABI stability.
| Family/version | Stability | Development | Purpose |
| -------------------- | ----------- | ------------------- | ----------------------------------- |
| (repo master branch) | Unstable | Active development | New feature development |
| mongocxx 3.9.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.10.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.9.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.8.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.7.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.6.x | Stable | None | Previous stable C++ driver release |
Expand Down
1 change: 1 addition & 0 deletions docs/content/mongocxx-v3/installation/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The mongocxx driver builds on top of the [MongoDB C driver](https://www.mongodb.
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 `CMAKE_PREFIX_PATH` to the directory containing the C driver install.

* For mongocxx-3.10.x, libmongoc 1.25.0 or later is required.
* For mongocxx-3.9.x, libmongoc 1.25.0 or later is required.
* For mongocxx-3.8.x, libmongoc 1.24.0 or later is required.
* For mongocxx-3.7.x, libmongoc 1.22.1 or later is required.
Expand Down
8 changes: 4 additions & 4 deletions docs/content/mongocxx-v3/installation/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ release tarball.

The [mongocxx releases](https://github.com/mongodb/mongo-cxx-driver/releases)
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.9.0:
example, to download version 3.10.0:

```sh
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
cd mongo-cxx-driver-r3.9.0/build
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz
tar -xzf mongo-cxx-driver-r3.10.0.tar.gz
cd mongo-cxx-driver-r3.10.0/build
```

Make sure you change to the `build` directory of whatever source tree you
Expand Down
8 changes: 4 additions & 4 deletions docs/content/mongocxx-v3/installation/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ release tarball.

The [mongocxx releases](https://github.com/mongodb/mongo-cxx-driver/releases)
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.9.0:
example, to download version 3.10.0:

```sh
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
cd mongo-cxx-driver-r3.9.0/build
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz
tar -xzf mongo-cxx-driver-r3.10.0.tar.gz
cd mongo-cxx-driver-r3.10.0/build
```

Make sure you change to the `build` directory of whatever source tree you
Expand Down
8 changes: 4 additions & 4 deletions docs/content/mongocxx-v3/installation/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ release tarball.

The [mongocxx releases](https://github.com/mongodb/mongo-cxx-driver/releases)
page will have links to the release tarball for the version you wish you install. For
example, to download version 3.9.0:
example, to download version 3.10.0:

```sh
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.9.0/mongo-cxx-driver-r3.9.0.tar.gz
tar -xzf mongo-cxx-driver-r3.9.0.tar.gz
cd mongo-cxx-driver-r3.9.0/build
curl -OL https://github.com/mongodb/mongo-cxx-driver/releases/download/r3.10.0/mongo-cxx-driver-r3.10.0.tar.gz
tar -xzf mongo-cxx-driver-r3.10.0.tar.gz
cd mongo-cxx-driver-r3.10.0/build
```

Make sure you change to the `build` directory of whatever source tree you
Expand Down
3 changes: 2 additions & 1 deletion etc/apidocmenu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Currently, no drivers guarantee API or ABI stability.
| Family/version | Stability | Development | Purpose |
| -------------------- | --------- | ------------------ | ---------------------------------- |
| (repo master branch) | Unstable | Active development | New feature development |
| mongocxx 3.9.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.10.x | Stable | Bug fixes only | Current stable C++ driver release |
| mongocxx 3.9.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.8.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.7.x | Stable | None | Previous stable C++ driver release |
| mongocxx 3.6.x | Stable | None | Previous stable C++ driver release |
Expand Down
1 change: 1 addition & 0 deletions etc/generate-all-apidocs.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ sub _try_run {
r3.8.0
r3.8.1
r3.9.0
r3.10.0
);

sub main {
Expand Down