[CDRIVER-3571] Use cmake, not make/msbuild, in documentation Created: 16/Mar/20  Updated: 28/Oct/23  Resolved: 26/Jun/20

Status: Closed
Project: C Driver
Component/s: docs
Affects Version/s: None
Fix Version/s: 1.17.0-rc0, 1.17.0

Type: Task Priority: Major - P3
Reporter: Kevin Albertson Assignee: Roberto Sanchez
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Cloners
is cloned by CDRIVER-3699 Use cmake, not make/msbuild, in compi... Closed
is cloned by CXX-1962 Use cmake, not make/msbuild, in docum... Closed

 Description   

Our documentation and test scripts configure using cmake and then use the native build system to compile. E.g. libmongoc's installation documentation has this for Unix:

$ cmake -DENABLE_AUTOMATIC_INIT_AND_CLEANUP=OFF ..
$ make install 

And this for Windows:

$ cmake -G "Visual Studio 14 2015 Win64" -DCMAKE_INSTALL_PREFIX="C:\mongo-c-driver" ..
$ msbuild.exe /p:Configuration=RelWithDebInfo INSTALL.vcxproj 

Using cmake for the build instructions may simplify this a bit, changing both build instructions to:

cmake --build cmake-build --config RelWithDebInfo --target install 

In addition, if we take this approach we may be able to consolidate some of compile-unix.sh, compile-windows.sh, and compile-windows-mingw.bat.

Documenting this as the way to build may also prevent users from accidentally mixing release/debug runtimes in their application, as there have been several related bug reports: CXX-1961CDRIVER-3558CXX-1780

This ticket is associated with the documentation update.



 Comments   
Comment by Githook User [ 11/Jul/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3571 consolidate and simplify installation doc
Branch: r1.17
https://github.com/mongodb/mongo-c-driver/commit/743dff21a06ce5fe4a935ee019c64656eee90fd8

Comment by Githook User [ 26/Jun/20 ]

Author:

{'name': 'Roberto C. Sánchez', 'email': 'roberto@connexer.com', 'username': 'rcsanchez97'}

Message: CDRIVER-3571 consolidate and simplify installation doc
Branch: master
https://github.com/mongodb/mongo-c-driver/commit/1763427bff432aca8abf01e753969343095cb496

Generated at Wed Feb 07 21:18:26 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.