Skip to content

Commit de4a643

Browse files
authored
Merge pull request #3220 from dscho/there-is-no-vs/master-anymore
Let the documentation reflect that there is no vs/master anymore
2 parents d837c67 + 1aaa8f9 commit de4a643

File tree

3 files changed

+15
-39
lines changed

3 files changed

+15
-39
lines changed

CONTRIBUTING.md

+5-15
Original file line numberDiff line numberDiff line change
@@ -78,22 +78,12 @@ release MSVC builds):
7878
make MSVC=1 DEBUG=1 -j12 clean
7979
```
8080

81-
### Using `vs/master` Solution
81+
### Using the IDE
8282

83-
If you prefer working in Visual Studio with a solution full of projects, then there is a
84-
branch in Git for Windows called [`vs/master`](https://github.com/git-for-windows/git/branches).
85-
This branch is kept up-to-date with the `master` branch, except it has one more commit that
86-
contains the solution and project files. Read [the wiki page on this approach](https://github.com/git-for-windows/git/wiki/Compiling-Git-with-Visual-Studio) for more information.
87-
88-
I want to make a small warning before you start working on the `vs/master` branch. If you
89-
create a new topic branch based on `vs/master`, you will need to rebase onto `master` before
90-
you can submit a pull request. The commit at the tip of `vs/master` is not intended to ever
91-
become part of the `master` branch. If you created a branch, `myTopic` based on `vs/master`,
92-
then use the following rebase command to move it onto the `master` branch:
93-
94-
```
95-
git rebase --onto master vs/master myTopic
96-
```
83+
If you prefer working in Visual Studio with a solution full of projects, then you can use
84+
CMake, either by letting Visual Studio configure it automatically (simply open Git's
85+
top-level directory via `File>Open>Folder...`) or by (downloading and) running
86+
[CMake](https://cmake.org) manually.
9787

9888
What to Change?
9989
---------------

SECURITY.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,4 @@ Note: even if those builds are not exactly "nightly", they are sometimes referre
6262

6363
## Following upstream's developments
6464

65-
The [gitforwindows/git repository](https://github.com/git-for-windows/git) also provides the `shears/*` and `vs/master` branches. The `shears/*` branches reflect Git for Windows' patches, rebased onto the upstream integration branches, [updated (mostly) via automated CI builds](https://dev.azure.com/git-for-windows/git/_build?definitionId=25).
66-
67-
# Other special branches
68-
69-
Currently, there is only one other special-purpose branch in Git for Windows: the `vs/master` branch. It adds a commit on top of git-for-Windows/git's `master`, providing the project files ready to build Git in Visual Studio using the MSVC tool chain, [also updated via automated builds](https://dev.azure.com/git-for-windows/git/_build?definitionId=27).
65+
The [gitforwindows/git repository](https://github.com/git-for-windows/git) also provides the `shears/*` branches. The `shears/*` branches reflect Git for Windows' patches, rebased onto the upstream integration branches, [updated (mostly) via automated CI builds](https://dev.azure.com/git-for-windows/git/_build?definitionId=25).

compat/vcbuild/README

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

4242
================================================================
4343

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

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

6656
================================================================
6757
The Steps of Build Git with VS2008

0 commit comments

Comments
 (0)