Skip to content

Commit 4629521

Browse files
kevinAlbskevinAlbs
committed
Prepare to generate r3.5.0 release documentation
1 parent ebec4e4 commit 4629521

File tree

5 files changed

+29
-20
lines changed

5 files changed

+29
-20
lines changed

‎README.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Currently, no drivers guarantee API or ABI stability.
2929
| Family/version | Stability | Development | Purpose |
3030
| -------------------- | ----------- | ------------------- | ----------------------------------- |
3131
| (repo master branch) | Unstable | Active development | New feature development |
32-
| mongocxx 3.4.x | Stable | Bug fixes only | Current stable C++ driver release |
32+
| mongocxx 3.5.x | Stable | Bug fixes only | Current stable C++ driver release |
33+
| mongocxx 3.4.x | Stable | None | Previous stable C++ driver release |
3334
| mongocxx 3.3.x | Stable | None | Previous stable C++ driver release |
3435
| mongocxx 3.2.x | Stable | None | Previous stable C++ driver release |
3536
| mongocxx 3.1.x | Stable | None | Previous stable C++ driver release |
@@ -43,6 +44,7 @@ is recommended for all new development.
4344

4445
| Family/version | MongoDB 3.0 | MongoDB 3.2 | MongoDB 3.4 | MongoDB 3.6 | MongoDB 4.0 | MongoDB 4.2 | MongoDB 4.4 |
4546
| -------------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- |
47+
| mongocxx 3.5.x | ✓ | ✓ | ✓ | ✓ | ✓ | Partial | |
4648
| mongocxx 3.4.x | ✓ | ✓ | ✓ | ✓ | ✓ | | |
4749
| mongocxx 3.3.x | ✓ | ✓ | ✓ | ✓ | | | |
4850
| mongocxx 3.2.x | ✓ | ✓ | ✓ | Partial | | | |

‎docs/content/index.md‎

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,28 +18,30 @@ out, take a look at these pages first:
1818
Stability indicates whether this driver is recommended for production use.
1919
Currently, no drivers guarantee API or ABI stability.
2020

21-
| Family/version | Stability | Development | Purpose |
22-
| -------------------- | ----------- | ------------------- | ------------------------------------ |
23-
| (repo master branch) | Unstable | Active development | New feature development |
24-
| mongocxx 3.4.x | Stable | Bug fixes only | Current stable C++ driver release |
25-
| mongocxx 3.3.x | Stable | None | Previous stable C++ driver release |
26-
| mongocxx 3.2.x | Stable | None | Previous stable C++ driver release |
27-
| mongocxx 3.1.x | Stable | None | Previous stable C++ driver release |
28-
| mongocxx 3.0.x | Stable | None | Previous stable C++ driver release |
21+
| Family/version | Stability | Development | Purpose |
22+
| -------------------- | ----------- | ------------------- | ----------------------------------- |
23+
| (repo master branch) | Unstable | Active development | New feature development |
24+
| mongocxx 3.5.x | Stable | Bug fixes only | Current stable C++ driver release |
25+
| mongocxx 3.4.x | Stable | None | Previous stable C++ driver release |
26+
| mongocxx 3.3.x | Stable | None | Previous stable C++ driver release |
27+
| mongocxx 3.2.x | Stable | None | Previous stable C++ driver release |
28+
| mongocxx 3.1.x | Stable | None | Previous stable C++ driver release |
29+
| mongocxx 3.0.x | Stable | None | Previous stable C++ driver release |
2930

3031
## MongoDB compatibility
3132

3233
The following compatibility table specifies the driver version(s)
3334
recommended for different versions of MongoDB. The mongocxx series
3435
is recommended for all new development.
3536

36-
| Family/version | MongoDB 2.4 | MongoDB 2.6 | MongoDB 3.0 | MongoDB 3.2 | MongoDB 3.4 | MongoDB 3.6 | MongoDB 4.0 |
37+
| Family/version | MongoDB 3.0 | MongoDB 3.2 | MongoDB 3.4 | MongoDB 3.6 | MongoDB 4.0 | MongoDB 4.2 | MongoDB 4.4 |
3738
| -------------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- |
38-
| mongocxx 3.4.x | | | ✓ | ✓ | ✓ | ✓ | ✓ |
39-
| mongocxx 3.3.x | | | ✓ | ✓ | ✓ | ✓ | |
40-
| mongocxx 3.2.x | ✓ | ✓ | ✓ | ✓ | ✓ | | |
41-
| mongocxx 3.1.x | ✓ | ✓ | ✓ | ✓ | ✓ | | |
42-
| mongocxx 3.0.x | ✓ | ✓ | ✓ | ✓ | | | |
39+
| mongocxx 3.5.x | ✓ | ✓ | ✓ | ✓ | ✓ | Partial | |
40+
| mongocxx 3.4.x | ✓ | ✓ | ✓ | ✓ | ✓ | | |
41+
| mongocxx 3.3.x | ✓ | ✓ | ✓ | ✓ | | | |
42+
| mongocxx 3.2.x | ✓ | ✓ | ✓ | Partial | | | |
43+
| mongocxx 3.1.x | ✓ | ✓ | ✓ | | | | |
44+
| mongocxx 3.0.x | ✓ | ✓ | | | | | |
4345

4446
## License
4547

‎docs/content/mongocxx-v3/installation.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ have problems, please file a bug report via
3232

3333
The mongocxx driver builds on top of the MongoDB C driver.
3434

35+
* For mongocxx-3.5.x, libmongoc 1.15.0 or later is required.
3536
* For mongocxx-3.4.x, libmongoc 1.13.0 or later is required.
3637
* For mongocxx-3.3.x, libmongoc 1.10.1 or later is required.
3738
* For mongocxx-3.2.x, libmongoc 1.9.2 or later is required.
@@ -103,12 +104,12 @@ cd mongo-cxx-driver/build
103104
If you prefer to download a tarball, look on the [mongocxx
104105
releases](https://github.com/mongodb/mongo-cxx-driver/releases) page for a
105106
link to the release tarball for the version you wish you install. For
106-
example, to download version 3.4.1:
107+
example, to download version 3.5.0:
107108

108109
```sh
109-
curl -OL https://github.com/mongodb/mongo-cxx-driver/archive/r3.4.1.tar.gz
110-
tar -xzf r3.4.1.tar.gz
111-
cd mongo-cxx-driver-r3.4.1/build
110+
curl -OL https://github.com/mongodb/mongo-cxx-driver/archive/r3.5.0.tar.gz
111+
tar -xzf r3.5.0.tar.gz
112+
cd mongo-cxx-driver-r3.5.0/build
112113
```
113114

114115
Make sure you change to the `build` directory of whatever source tree you

‎etc/apidocmenu.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Currently, no drivers guarantee API or ABI stability.
88
| Family/version | Stability | Development | Purpose |
99
| -------------------- | ----------- | ------------------- | ------------------------------------- |
1010
| (repo master branch) | Unstable | Active development | New feature development |
11-
| mongocxx 3.4.x | Stable | Bug fixes only | Current stable C++ driver release |
11+
| mongocxx 3.5.x | Stable | Bug fixes only | Current stable C++ driver release |
12+
| mongocxx 3.4.x | Stable | None | Previous stable C++ driver release |
1213
| mongocxx 3.3.x | Stable | None | Previous stable C++ driver release |
1314
| mongocxx 3.2.x | Stable | None | Previous stable C++ driver release |
1415
| mongocxx 3.1.x | Stable | None | Previous stable C++ driver release |
@@ -18,6 +19,7 @@ Currently, no drivers guarantee API or ABI stability.
1819

1920
| mongocxx |
2021
| ------------------------------------ |
22+
| [mongocxx-3.5.0](../mongocxx-3.5.0) |
2123
| [mongocxx-3.4.1](../mongocxx-3.4.1) |
2224
| [mongocxx-3.4.0](../mongocxx-3.4.0) |
2325
| [mongocxx-3.3.1](../mongocxx-3.3.1) |
@@ -41,6 +43,7 @@ is recommended for all new development.
4143

4244
| Family/version | MongoDB 3.0 | MongoDB 3.2 | MongoDB 3.4 | MongoDB 3.6 | MongoDB 4.0 | MongoDB 4.2 | MongoDB 4.4 |
4345
| -------------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- | ----------- |
46+
| mongocxx 3.5.x | ✓ | ✓ | ✓ | ✓ | ✓ | Partial | |
4447
| mongocxx 3.4.x | ✓ | ✓ | ✓ | ✓ | ✓ | | |
4548
| mongocxx 3.3.x | ✓ | ✓ | ✓ | ✓ | | | |
4649
| mongocxx 3.2.x | ✓ | ✓ | ✓ | Partial | | | |

‎etc/generate-all-apidocs.pl‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ sub _try_run {
4343
r3.3.1
4444
r3.4.0
4545
r3.4.1
46+
r3.5.0
4647
);
4748

4849
sub main {

0 commit comments

Comments
 (0)