Skip to content

Commit 9f62d86

Browse files
authored
Fix broken links (#1071)
* replace `classmongocxx_1_1` with `classmongocxx_1_1v__noabi_1_1` * replace `classbsoncxx_1_1` with `classbsoncxx_1_1v__noabi_1_1` * fix links to GitHub sources * replace `http://mongocxx.org` with `https://mongocxx.org` * fix link to `insert_one_result` * replace `mongodb.github.io` with `mongocxx.org`
1 parent 70d26e2 commit 9f62d86

File tree

13 files changed

+46
-46
lines changed

13 files changed

+46
-46
lines changed

debian/control

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Build-Depends: debhelper (>= 11),
1616
doxygen
1717
Standards-Version: 4.6.2
1818
Section: libs
19-
Homepage: http://mongocxx.org/
19+
Homepage: https://mongocxx.org/
2020
Vcs-Git: https://github.com/mongodb/mongo-cxx-driver.git
2121
Vcs-Browser: https://github.com/mongodb/mongo-cxx-driver/tree/master
2222

docs/config.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
baseurl = "http://mongocxx.org"
1+
baseurl = "https://mongocxx.org"
22
languageCode = "en-us"
33
title = "MongoDB C++ Driver Manual"
44
theme = "mongodb"
@@ -30,7 +30,7 @@ publishdir = "../build/hugo"
3030
pre = "<i class='fa fa-file-text-o'></i>"
3131
weight = 90
3232
identifier = "apiDocs"
33-
url = "https://mongodb.github.io/mongo-cxx-driver/api/current"
33+
url = "https://mongocxx.org/api/current"
3434

3535
[[menu.main]]
3636
name = "Contributing"

docs/content/mongocxx-v3/configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title = "Configuring the mongocxx driver"
99
In the mongocxx driver, most configuration is done via the [connection
1010
URI](https://www.mongodb.com/docs/manual/reference/connection-string/). Some
1111
additional connection options are possible via the
12-
[mongocxx::options::client]({{< api3ref classmongocxx_1_1options_1_1client
12+
[mongocxx::options::client]({{< api3ref classmongocxx_1_1v__noabi_1_1options_1_1client
1313
>}}) class.
1414
1515
## Configuring TLS/SSL
@@ -21,7 +21,7 @@ To enable TLS (SSL), set `tls=true` in the URI:
2121
By default, mongocxx will verify server certificates against the local
2222
system CA list. You can override that either by specifying different settings in
2323
the connection string, or by creating a
24-
[mongocxx::options::tls]({{< api3ref classmongocxx_1_1options_1_1tls >}})
24+
[mongocxx::options::tls]({{< api3ref classmongocxx_1_1v__noabi_1_1options_1_1tls >}})
2525
object and passing it to `tls_opts` on mongocxx::options::client.
2626

2727
For example, to use a custom CA or to disable certificate validation,
@@ -109,7 +109,7 @@ See the MongoDB server
109109
for more information about determining the subject name from the
110110
certificate.
111111

112-
The PEM file can also be specified using the [mongocxx::options::tls]({{< api3ref classmongocxx_1_1options_1_1tls >}}) class, see the first "Configuring TLS/SSL" example above.
112+
The PEM file can also be specified using the [mongocxx::options::tls]({{< api3ref classmongocxx_1_1v__noabi_1_1options_1_1tls >}}) class, see the first "Configuring TLS/SSL" example above.
113113

114114
### Kerberos (GSSAPI)
115115

docs/content/mongocxx-v3/tutorial.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ c++ --std=c++11 <input>.cpp
6363
## Make a Connection
6464

6565
**IMPORTANT**: Before making any connections, you need to create one and only
66-
one instance of [`mongocxx::instance`]({{< api3ref classmongocxx_1_1instance >}}).
66+
one instance of [`mongocxx::instance`]({{< api3ref classmongocxx_1_1v__noabi_1_1instance >}}).
6767
This instance must exist for the entirety of your program.
6868

6969
To connect to a running MongoDB instance, use the
70-
[`mongocxx::client`]({{< api3ref classmongocxx_1_1client >}})
70+
[`mongocxx::client`]({{< api3ref classmongocxx_1_1v__noabi_1_1client >}})
7171
class.
7272

7373
You must specify the host to connect to using a
74-
[`mongocxx::uri`]({{< api3ref classmongocxx_1_1uri >}}) instance containing a
74+
[`mongocxx::uri`]({{< api3ref classmongocxx_1_1v__noabi_1_1uri >}}) instance containing a
7575
[MongoDB URI](https://www.mongodb.com/docs/manual/reference/connection-string/),
7676
and pass that into the `mongocxx::client` constructor. For details regarding
7777
supported URI options see the documentation for the version of libmongoc used
@@ -96,10 +96,10 @@ mongocxx::client client(uri);
9696

9797
## Access a Database
9898

99-
Once you have a [`mongocxx::client`]({{< api3ref classmongocxx_1_1client >}})
99+
Once you have a [`mongocxx::client`]({{< api3ref classmongocxx_1_1v__noabi_1_1client >}})
100100
instance connected to a MongoDB deployment, use either the
101101
`database()` method or `operator[]` to obtain a
102-
[`mongocxx::database`]({{< api3ref classmongocxx_1_1database >}})
102+
[`mongocxx::database`]({{< api3ref classmongocxx_1_1v__noabi_1_1database >}})
103103
instance.
104104

105105
If the database you request does not exist, MongoDB creates it when you
@@ -114,9 +114,9 @@ auto db = client["mydb"];
114114
## Access a Collection
115115

116116
Once you have a
117-
[`mongocxx::database`]({{< api3ref classmongocxx_1_1database >}})
117+
[`mongocxx::database`]({{< api3ref classmongocxx_1_1v__noabi_1_1database >}})
118118
instance, use either the `collection()` method or `operator[]` to obtain a
119-
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1collection >}})
119+
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1v__noabi_1_1collection >}})
120120
instance.
121121

122122
If the collection you request does not exist, MongoDB creates it when
@@ -174,7 +174,7 @@ auto doc_value = make_document(
174174
175175
This `bsoncxx::document::value` type is a read-only object owning
176176
its own memory. To use it, you must obtain a
177-
[`bsoncxx::document::view`]({{< api3ref classbsoncxx_1_1document_1_1view >}}) using
177+
[`bsoncxx::document::view`]({{< api3ref classbsoncxx_1_1v__noabi_1_1document_1_1view >}}) using
178178
the `view()` method:
179179
180180
```c++
@@ -183,7 +183,7 @@ auto doc_view = doc_value.view();
183183

184184
You can access fields within this document view using `operator[]`,
185185
which will return a
186-
[`bsoncxx::document::element`]({{< api3ref classbsoncxx_1_1document_1_1element >}})
186+
[`bsoncxx::document::element`]({{< api3ref classbsoncxx_1_1v__noabi_1_1document_1_1element >}})
187187
instance. For example, the following will extract the `name` field whose
188188
value is a string:
189189

@@ -197,25 +197,25 @@ assert(0 == name.compare("MongoDB"));
197197
If the value in the `name` field is not a string and you do not
198198
include a type guard as seen in the preceding example, this code will
199199
throw an instance of
200-
[`bsoncxx::exception`]({{< api3ref classbsoncxx_1_1exception >}}).
200+
[`bsoncxx::exception`]({{< api3ref classbsoncxx_1_1v__noabi_1_1exception >}}).
201201
202202
## Insert Documents
203203
204204
### Insert One Document
205205
206206
To insert a single document into the collection, use a
207-
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1collection >}})
207+
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1v__noabi_1_1collection >}})
208208
instance's `insert_one()` method to insert `{ "i": 0 }`:
209209
210210
```c++
211211
auto insert_one_result = collection.insert_one(make_document(kvp("i", 0)));
212212
```
213213

214214
`insert_one_result` is an optional [`mongocxx::result::insert_one`]({{< api3ref
215-
classmongocxx_1_1result_1_1insert_one >}}). In this example, `insert_one_result`
215+
classmongocxx_1_1v__noabi_1_1result_1_1insert__one >}}). In this example, `insert_one_result`
216216
is expected to be set. The default behavior for write operations is to wait for
217217
a reply from the server. This may be overriden by setting an unacknowledged
218-
[`mongocxx::write_concern`]({{< api3ref classmongocxx_1_1write__concern >}}).
218+
[`mongocxx::write_concern`]({{< api3ref classmongocxx_1_1v__noabi_1_1write__concern >}}).
219219

220220
```c++
221221
assert(insert_one_result); // Acknowledged writes return results.
@@ -226,7 +226,7 @@ MongoDB automatically adds an `_id` field to the inserted document.
226226
227227
You can obtain this value using the `inserted_id()` method of the
228228
returned
229-
[`mongocxx::result::insert_one`]({{< api3ref classmongocxx_1_1result_1_1insert__one >}})
229+
[`mongocxx::result::insert_one`]({{< api3ref classmongocxx_1_1v__noabi_1_1result_1_1insert__one >}})
230230
instance.
231231
232232
```c++
@@ -237,7 +237,7 @@ assert(doc_id.type() == bsoncxx::type::k_oid);
237237
### Insert Multiple Documents
238238

239239
To insert multiple documents to the collection, use a
240-
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1collection >}}) instance's
240+
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1v__noabi_1_1collection >}}) instance's
241241
`insert_many()` method, which takes a list of documents to insert.
242242

243243
The following example inserts the documents `{ "i": 1 }` and `{ "i": 2 }`.
@@ -262,7 +262,7 @@ MongoDB automatically adds a `_id` field to the inserted documents.
262262
263263
You can obtain this value using the `inserted_ids()` method of the
264264
returned
265-
[`mongocxx::result::insert_many`]({{< api3ref classmongocxx_1_1result_1_1insert__many >}})
265+
[`mongocxx::result::insert_many`]({{< api3ref classmongocxx_1_1v__noabi_1_1result_1_1insert__many >}})
266266
instance.
267267
268268
```c++
@@ -278,9 +278,9 @@ To query the collection, use the collection’s `find()` and
278278
`find_one` methods.
279279

280280
`find()` will return an instance of
281-
[`mongocxx::cursor`]({{< api3ref classmongocxx_1_1cursor >}}),
281+
[`mongocxx::cursor`]({{< api3ref classmongocxx_1_1v__noabi_1_1cursor >}}),
282282
while `find_one()` will return an instance of
283-
`std::optional<`[`bsoncxx::document::value`]({{< api3ref classbsoncxx_1_1document_1_1value >}})`>`
283+
`std::optional<`[`bsoncxx::document::value`]({{< api3ref classbsoncxx_1_1v__noabi_1_1document_1_1value >}})`>`
284284

285285
You can call either method with an empty document to query all documents
286286
in a collection, or pass a filter to query for documents that match the
@@ -369,7 +369,7 @@ To update documents in a collection, you can use the collection’s
369369
`update_one()` and `update_many()` methods.
370370

371371
The update methods return an instance of
372-
`std::optional<`[`mongocxx::result::update`]({{< api3ref classmongocxx_1_1result_1_1update >}})`>`,
372+
`std::optional<`[`mongocxx::result::update`]({{< api3ref classmongocxx_1_1v__noabi_1_1result_1_1update >}})`>`,
373373
which provides information about the operation including the number of
374374
documents modified by the update.
375375

@@ -411,7 +411,7 @@ To delete documents from a collection, you can use a collection’s
411411
`delete_one()` and `delete_many()` methods.
412412

413413
The delete methods return an instance of
414-
`std::optional<`[`mongocxx::result::delete`]({{< api3ref classmongocxx_1_1result_1_1delete__result >}})`>`,
414+
`std::optional<`[`mongocxx::result::delete`]({{< api3ref classmongocxx_1_1v__noabi_1_1result_1_1delete__result >}})`>`,
415415
which contains the number of documents deleted.
416416

417417
### Delete a Single Document
@@ -447,7 +447,7 @@ assert(delete_many_result->deleted_count() == 2);
447447
To create an [index](https://www.mongodb.com/docs/manual/indexes/) on a
448448
field or set of fields, pass an index specification document to the
449449
`create_index()` method of a
450-
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1collection >}}) instance. An
450+
[`mongocxx::collection`]({{< api3ref classmongocxx_1_1v__noabi_1_1collection >}}) instance. An
451451
index key specification document contains the fields to index and the
452452
index type for each field:
453453

docs/content/mongocxx-v3/working-with-bson.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ use each. For more information and example code, see our
2525
The bsoncxx library offers four interfaces for building BSON: one-off
2626
functions, a basic builder, a list builder and a stream-based builder.
2727

28-
[`bsoncxx::builder::basic::document`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/builder/basic/document.hpp)<br/>
29-
[`bsoncxx::builder::stream::document`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/builder/stream/document.hpp)
28+
[`bsoncxx::builder::basic::document`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/builder/basic/document.hpp)<br/>
29+
[`bsoncxx::builder::stream::document`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/builder/stream/document.hpp)
3030

3131
The various methods of creating BSON documents and arrays are all
3232
equivalent. All interfaces will provide the same results, the choice of
@@ -175,7 +175,7 @@ for (auto && e : {1, 2, 3}) {
175175

176176
### <a name="value">Owning BSON Documents (values)</a>
177177

178-
[`bsoncxx::document::value`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/document/value.hpp)
178+
[`bsoncxx::document::value`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/document/value.hpp)
179179

180180
This type represents an actual BSON document, one that owns its buffer of
181181
data. These documents can be constructed from a builder by calling
@@ -200,7 +200,7 @@ bsoncxx::document::value one_line = bsoncxx::builder::stream::document{} << "fin
200200

201201
### <a name="view">Non-owning BSON Documents (views)</a>
202202

203-
[`bsoncxx::document::view`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/document/view.hpp)
203+
[`bsoncxx::document::view`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/document/view.hpp)
204204

205205
This type is a view into an owning `bsoncxx::document::value`.
206206

@@ -232,7 +232,7 @@ auto cursor2 = collection2.find(query_value.view());
232232

233233
### <a name="view_or_value">Optionally-owning BSON Documents (view_or_value)</a>
234234

235-
Many driver methods take a document::view_or_value parameter, for example, [`run_command`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/mongocxx/database.hpp#L83-L92):
235+
Many driver methods take a document::view_or_value parameter, for example, [`run_command`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/mongocxx/include/mongocxx/v_noabi/mongocxx/database.hpp#L144-L153):
236236

237237
```
238238
bsoncxx::document::value run_command(bsoncxx::document::view_or_value command);
@@ -297,7 +297,7 @@ bsoncxx::document::view dangling_view = temp_builder.extract().view(); // Bad!!
297297

298298
### <a name="print">Printing BSON Documents</a>
299299

300-
[`bsoncxx::to_json()`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/json.hpp#L28-L36)
300+
[`bsoncxx::to_json()`](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/json.hpp#L39-L55)
301301

302302
The bsoncxx library comes with a convenience method to convert BSON
303303
documents to strings for easy inspection:
@@ -307,7 +307,7 @@ bsoncxx::document::value = document{} << "I am" << "a BSON document" << finalize
307307
std::cout << bsoncxx::to_json(doc.view()) << std::endl;
308308
```
309309

310-
There is an analogous method, [from_json()](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/json.hpp#L60-L68), to build document::values out of existing JSON strings.
310+
There is an analogous method, [from_json()](https://github.com/mongodb/mongo-cxx-driver/blob/master/src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/json.hpp#L57-L67), to build document::values out of existing JSON strings.
311311

312312
### <a name="fields">Getting Fields out of BSON Documents</a>
313313

@@ -335,7 +335,7 @@ This feature is shown in more detail in [this example](https://github.com/mongod
335335

336336
The [BSON specification](http://bsonspec.org/spec.html) provides a list
337337
of supported types. These are represented in C++ using the
338-
[b_xxx](https://mongodb.github.io/mongo-cxx-driver/api/current/classes.html#letter_B)
338+
[b_xxx](https://mongocxx.org/api/current/classes.html#letter_B)
339339
type wrappers.
340340

341341
Some BSON types don't necessarily have a native representation to wrap and

docs/data/mongodb.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
githubRepo = "mongo-cxx-driver"
33
githubBranch = "master"
44
highlightTheme = "idea.css"
5-
api3Url = "https://mongodb.github.io/mongo-cxx-driver/api/mongocxx-v3"
6-
api1Url = "https://mongodb.github.io/mongo-cxx-driver/api/legacy-v1"
5+
api3Url = "https://mongocxx.org/api/mongocxx-v3"
6+
api1Url = "https://mongocxx.org/api/legacy-v1"
77

docs/themes/mongodb/theme.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ name = "MongoDB"
22
license = "Creative Commons Attribution NonCommercial ShareAlike 3.0 Unported"
33
licenselink = "http://creativecommons.org/licenses/by-nc-sa/3.0/"
44
description = "A standalone mongodb docs theme, for individual driver homepages"
5-
homepage = "https://mongodb.github.io/mongo-cxx-driver"
5+
homepage = "https://mongocxx.org/"
66

77
[author]
88
name = "MongoDB C++ driver authors"
9-
homepage = "https://mongodb.github.io/mongo-cxx-driver"
9+
homepage = "https://mongocxx.org/"
1010

1111
[original]
1212
name = "MongoDB Docs"

examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
## Building code examples
88

99
1. Run `git clone https://github.com/mongodb/mongo-cxx-driver && cd mongo-cxx-driver/build`
10-
2. Follow the instructions [here](https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/) to install the driver
10+
2. Follow the instructions [here](https://mongocxx.org/mongocxx-v3/installation/) to install the driver
1111
3. Run `make examples`
1212
4. cd `examples/mongocxx`
1313
5. Start up `mongod` running on the default port (i.e. 27017)
@@ -16,6 +16,6 @@
1616
## Building project examples
1717

1818
1. Install `libmongoc` and `mongocxx` following the [installation
19-
instructions](https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/installation/)
19+
instructions](https://mongocxx.org/mongocxx-v3/installation/)
2020
2. Change to one of the project example directories, e.g. `examples/projects/cmake/mongocxx/shared`
2121
3. Run `./build.sh`

src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/builder/stream/array.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ namespace stream {
3636
/// a BSON array.
3737
///
3838
/// @note Use of the stream builder is discouraged. See
39-
/// https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/working-with-bson/#stream-builder for
39+
/// https://mongocxx.org/mongocxx-v3/working-with-bson/#stream-builder for
4040
/// more details.
4141
///
4242
class array : public array_context<> {

src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/builder/stream/document.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ namespace stream {
3434
/// a BSON document.
3535
///
3636
/// @note Use of the stream builder is discouraged. See
37-
/// https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/working-with-bson/#stream-builder for
37+
/// https://mongocxx.org/mongocxx-v3/working-with-bson/#stream-builder for
3838
/// more details.
3939
///
4040
class document : public key_context<> {

src/bsoncxx/include/bsoncxx/v_noabi/bsoncxx/builder/stream/helpers.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ struct open_array_type {
6060
///
6161
/// A stream manipulator to open a subarray.
6262
///
63-
/// @see https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/working-with-bson/#builders for help
63+
/// @see https://mongocxx.org/mongocxx-v3/working-with-bson/#builders for help
6464
/// building arrays in loops.
6565
///
6666
constexpr open_array_type open_array;

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ inline namespace v_noabi {
5656
/// @endcode
5757
///
5858
/// Note that client is not thread-safe. See
59-
/// https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/thread-safety/ for more details.
59+
/// https://mongocxx.org/mongocxx-v3/thread-safety/ for more details.
6060
class client {
6161
public:
6262
///

src/mongocxx/include/mongocxx/v_noabi/mongocxx/client_session.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ inline namespace v_noabi {
3838
/// or snapshots.
3939
///
4040
/// Note that client_session is not thread-safe. See
41-
/// https://mongodb.github.io/mongo-cxx-driver/mongocxx-v3/thread-safety/ for more details.
41+
/// https://mongocxx.org/mongocxx-v3/thread-safety/ for more details.
4242
///
4343
/// @see
4444
/// https://www.mongodb.com/docs/manual/core/read-isolation-consistency-recency/#causal-consistency

0 commit comments

Comments
 (0)