From 7f068428032ed03d13949c49340cd9958c2b58fe Mon Sep 17 00:00:00 2001 From: Thomas Castiglione Date: Sun, 4 Feb 2024 16:03:03 +0800 Subject: [PATCH] docs: note improved Windows symlink support --- CHANGELOG.md | 3 +++ docs/windows.md | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4884a7383a3..06050e4618a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -102,6 +102,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 abandoned by Git. [#2876](https://github.com/martinvonz/jj/issues/2876) +* Added support for symlinks on Windows when Developer Mode is enabled. + [#2](https://github.com/martinvonz/jj/issues/2) + ## [0.13.0] - 2024-01-03 diff --git a/docs/windows.md b/docs/windows.md index 5cc8759d703..d1c3492c7c3 100644 --- a/docs/windows.md +++ b/docs/windows.md @@ -62,3 +62,13 @@ Then only use the `~/my-repo` workspace from Linux. [issue-2040]: https://github.com/martinvonz/jj/issues/2040 [array-op]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_arrays?view=powershell-7.4#the-array-sub-expression-operator + +## Symbolic link support + +`jj` supports symlinks on Windows only when they arere enabled by the operating +system. This requires Windows 10 version 14972 or higher, as well as Developer +Mode. If those conditions are not satisfied, `jj` will (for now) crash when the +working copy contains symlinks. + +For colocated repositories, `git` symlink support must also be enabled using the +config option `core.symlinks=true`. \ No newline at end of file