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 15, 2024
1 parent aec5677 commit b3668be
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixed bugs

* On Windows, symlinks in the repo are now materialized as regular files in the
* On Windows, symlinks in the repo are now are now supported when Developer Mode is enabled.
When symlink support is unavailable, they will be materialized as regular files in the
working copy (instead of resulting in a crash).

[#2](https://github.com/martinvonz/jj/issues/2)

* On Windows, the pager will now be the built-in instead of disabled.

## [0.14.0] - 2024-02-07
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 materialize symlinks as
ordinary files.

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

0 comments on commit b3668be

Please sign in to comment.