cmake (Windows): recommend using Visual Studio's built-in CMake support

It is a lot more convenient to use than having to specify the
configuration in CMake manually (does not matter whether using the
command-line or CMake's GUI).

While at it, recommend using `contrib/buildsystems/out/` as build
directory also in the part that talks about running CMake manually.

Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Johannes Schindelin 2020-09-30 15:26:23 +00:00 committed by Junio C Hamano
parent b490283d52
commit f2f1250c47

View File

@ -4,17 +4,25 @@
#[[ #[[
Instructions to run CMake: Instructions how to use this in Visual Studio:
cmake `relative-path-to-CMakeLists.txt` -DCMAKE_BUILD_TYPE=Release Open the worktree as a folder. Visual Studio 2019 and later will detect
Eg. the CMake configuration automatically and set everything up for you,
From the root of git source tree ready to build. You can then run the tests in `t/` via a regular Git Bash.
`cmake contrib/buildsystems/ `
This will build the git binaries at the root
For out of source builds, say build in 'git/git-build/' Note: Visual Studio also has the option of opening `CMakeLists.txt`
`mkdir git-build;cd git-build; cmake ../contrib/buildsystems/` directly; Using this option, Visual Studio will not find the source code,
This will build the git binaries in git-build directory though, therefore the `File>Open>Folder...` option is preferred.
Instructions to run CMake manually:
mkdir -p contrib/buildsystems/out
cd contrib/buildsystems/out
cmake ../ -DCMAKE_BUILD_TYPE=Release
This will build the git binaries in contrib/buildsystems/out
directory (our top-level .gitignore file knows to ignore contents of
this directory).
Possible build configurations(-DCMAKE_BUILD_TYPE) with corresponding Possible build configurations(-DCMAKE_BUILD_TYPE) with corresponding
compiler flags compiler flags