Skip to content

Commit 36e1aa4

Browse files
committed
compat/vcbuild: document preferred way to build in Visual Studio
We used to have that `make vcxproj` hack, but a hack it is. In the meantime, we have a much cleaner solution: using CMake, either explicitly, or even more conveniently via Visual Studio's built-in CMake support (simply open Git's top-level directory via File>Open>Folder...). Let's let the `README` reflect this. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 5501b4a commit 36e1aa4

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

compat/vcbuild/README

+9-19
Original file line numberDiff line numberDiff line change
@@ -37,27 +37,17 @@ The Steps to Build Git with VS2015 or VS2017 from the command line.
3737

3838
================================================================
3939

40-
Alternatively, run `make vcxproj` and then load the generated `git.sln` in
41-
Visual Studio. The initial build will install the vcpkg system and build the
40+
Alternatively, just open Git's top-level directory in Visual Studio, via
41+
`File>Open>Folder...`. This will use CMake internally to generate the
42+
project definitions. It will also install the vcpkg system and build the
4243
dependencies automatically. This will take a while.
4344

44-
Instead of generating the `git.sln` file yourself (which requires a full Git
45-
for Windows SDK), you may want to consider fetching the `vs/master` branch of
46-
https://github.com/git-for-windows/git instead (which is updated automatically
47-
via CI running `make vcxproj`). The `vs/master` branch does not require a Git
48-
for Windows to build, but you can run the test scripts in a regular Git Bash.
49-
50-
Note that `make vcxproj` will automatically add and commit the generated `.sln`
51-
and `.vcxproj` files to the repo. This is necessary to allow building a
52-
fully-testable Git in Visual Studio, where a regular Git Bash can be used to
53-
run the test scripts (as opposed to a full Git for Windows SDK): a number of
54-
build targets, such as Git commands implemented as Unix shell scripts (where
55-
`@@SHELL_PATH@@` and other placeholders are interpolated) require a full-blown
56-
Git for Windows SDK (which is about 10x the size of a regular Git for Windows
57-
installation).
58-
59-
If your plan is to open a Pull Request with Git for Windows, it is a good idea
60-
to drop this commit before submitting.
45+
You can also generate the Visual Studio solution manually by downloading
46+
and running CMake explicitly rather than letting Visual Studio doing
47+
that implicitly.
48+
49+
Another, deprecated option is to run `make vcxproj`. This option is
50+
superseded by the CMake-based build, and will be removed at some point.
6151

6252
================================================================
6353
The Steps of Build Git with VS2008

0 commit comments

Comments
 (0)