Skip to content

Commit

Permalink
docs: note improved Windows symlink support
Browse files Browse the repository at this point in the history
  • Loading branch information
gulbanana committed Feb 7, 2024
1 parent 4c7ebac commit 1509ee3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
10 changes: 10 additions & 0 deletions docs/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 display an error when the
working copy contains symlinks.

For colocated repositories, `git` symlink support must also be enabled using the
config option `core.symlinks=true`.

0 comments on commit 1509ee3

Please sign in to comment.