Skip to content

Commit

Permalink
fix typo, additional cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
@rcsanchez97
rcsanchez97 committed Dec 4, 2024
1 parent 1952195 commit 82b2894
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions source/include-link.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Once the {+driver-short+} is installed, then create a project directory. For thi
:caption: /home/user/project1/CMakeLists.txt
:start-after: -- sphinx-include-start --

The project can then be built and executed. Note that depending on your particular environment, you may need to specify additional options to the first CMake command below. For instance, if your compiler does not default to at least c++17, then you may need ``-DCMAKE_CXX_STANDARD=17``. And if in the installation step you installed the {+driver-short+} to a non-standard location, you may need to specify ``-DCMAKE_PREFIX_PATH=/<path-to-mongo-cxx-driver-installation>``. The execution should resemeble:
The project can then be built and executed. Note that depending on your particular environment, you may need to specify additional options to the first CMake command below. For instance, if your compiler does not default to at least c++17, then you may need ``-DCMAKE_CXX_STANDARD=17``. And if in the installation step you installed the {+driver-short+} to a non-standard location, you may need to specify ``-DCMAKE_PREFIX_PATH=/<path-to-mongo-cxx-driver-installation>``. The execution should resemble:

Check failure on line 37 in source/include-link.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/include-link.txt", "range": {"start": {"line": 37, "column": 105}}}, "severity": "ERROR"}

Check failure on line 37 in source/include-link.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'more' is preferred over 'additional'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'more' is preferred over 'additional'.", "location": {"path": "source/include-link.txt", "range": {"start": {"line": 37, "column": 121}}}, "severity": "ERROR"}

Check failure on line 37 in source/include-link.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.

Raw Output:
{"message": "[MongoDB.ConciseTerms] 'must' is preferred over 'need to'.", "location": {"path": "source/include-link.txt", "range": {"start": {"line": 37, "column": 391}}}, "severity": "ERROR"}

Check failure on line 37 in source/include-link.txt

View workflow job for this annotation

GitHub Actions / TDBX Vale rules 

[vale] reported by reviewdog 🐶
[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.

Raw Output:
{"message": "[MongoDB.AvoidSubjunctive] Avoid the subjunctive 'should'.", "location": {"path": "source/include-link.txt", "range": {"start": {"line": 37, "column": 487}}}, "severity": "ERROR"}

.. code-block:: none

Expand Down Expand Up @@ -160,9 +160,3 @@ Assuming a source file located at ``/<path-to-mongo-cxx-driver-sources>/examples
members

The above command line can be adapted for more complex projects (e.g., by adding module version consrtaints) or specific build systems depending on how they consume pkg-config packages.

TODO
source/advanced-installation.txt
https://www.mongodb.com/docs/languages/c/c-driver/current/libmongoc/tutorial/#cmake
https://www.mongodb.com/docs/languages/cpp/cpp-driver/upcoming/advanced-installation/
https://www.mongodb.com/docs/languages/cpp/cpp-driver/current/tutorial/

0 comments on commit 82b2894

Please sign in to comment.