summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/windows.md33
1 files changed, 29 insertions, 4 deletions
diff --git a/docs/windows.md b/docs/windows.md
index 80912964..4282bebf 100644
--- a/docs/windows.md
+++ b/docs/windows.md
@@ -19,7 +19,33 @@ also due to most developers not using Windows.
19We will never add code specific to older versions of Windows. 19We will never add code specific to older versions of Windows.
20It might work, but it most likely won't, so please don't bother asking. 20It might work, but it most likely won't, so please don't bother asking.
21 21
22## Symlinks 22## Git worktrees
23
24*** note
25**Warning**: Repo's support for Git worktrees is new & experimental.
26Please report any bugs and be sure to maintain backups!
27***
28
29The Repo 2.4 release introduced support for [Git worktrees][git-worktree].
30You don't have to worry about or understand this particular feature, so don't
31worry if this section of the Git manual is particularly impenetrable.
32
33The salient point is that Git worktrees allow Repo to create repo client
34checkouts that do not require symlinks at all under Windows.
35This means users no longer need Administrator access to sync code.
36
37Simply use `--worktree` when running `repo init` to opt in.
38
39This does not effect specific Git repositories that use symlinks themselves.
40
41[git-worktree]: https://git-scm.com/docs/git-worktree
42
43## Symlinks by default
44
45*** note
46**NB**: This section applies to the default Repo behavior which does not use
47Git worktrees (see the previous section for more info).
48***
23 49
24Repo will use symlinks heavily internally. 50Repo will use symlinks heavily internally.
25On *NIX platforms, this isn't an issue, but Windows makes it a bit difficult. 51On *NIX platforms, this isn't an issue, but Windows makes it a bit difficult.
@@ -62,9 +88,8 @@ This also helps `tar` unpack symlinks, so that's nice.
62 88
63## Python 89## Python
64 90
65You should make sure to be running Python 3.6 or newer under Windows. 91Python 3.6 or newer is required.
66Python 2 might work, but due to already limited platform testing, you should 92Python 2 is known to be broken when running under Windows.
67only run newer Python versions.
68See our [Python Support](./python-support.md) document for more details. 93See our [Python Support](./python-support.md) document for more details.
69 94
70You can grab the latest Windows installer here:<br> 95You can grab the latest Windows installer here:<br>