You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: gitkraken-client/windows-subsystem-for-linux.md
+17-11Lines changed: 17 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,18 +9,21 @@ taxonomy:
9
9
10
10
## Working with WSL 2
11
11
12
-
<ahref="https://learn.microsoft.com/en-us/windows/wsl/about"target="_blank">Windows Subsystem for Linux (WSL)</a>
12
+
<ahref="https://learn.microsoft.com/en-us/windows/wsl/about"target="_blank">Windows Subsystem for Linux (WSL)</a> lets developers install a Linux distribution and use Linux applications, utilities, and Bash command-line tools directly on Windows. <ahref="https://learn.microsoft.com/en-us/windows/wsl/compare-versions"target="_blank">WSL 2</a> utilizes an actual Linux kernel inside a managed virtual machine (VM) to provide improved performance and full system call capability, and is now the default WSL version. Microsoft notes that WSL 2 lacks performance across OS file systems however, and this issue can be addressed by storing your project files on the same operating system as the tools you are running to work on the project.
13
+
14
+
Microsoft also introduced <a href="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps"
15
+
target="_blank">Windows Subsystem for Linux GUI (WSLg)</a>, a feature aimed to provide the ability to run Linux GUI applications which work best, or exclusively, in a Linux/WSL 2 environment. Using WSLg also better enables Linux GUI applications like the Linux version of GitKraken Client to feel native and natural to use on Windows by integrating them closely into the Windows desktop experience when running within WSL 2.
GitKraken Client can work with repos stored on your WSL 2 file system when installed within the WSL 2 environment and using WSL’s built-in display server functionality, <ahref="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps"target="_blank">WSLg</a>, for GUI support. The Linux version of GitKraken client is upated to fix common issues when operating GitKraken within WSL 2, and includes settings to choose your preference for where to open web links, file editors, and file browsers.
20
+
GitKraken Client can work with repos stored on your WSL 2 file system when installed within the WSL 2 environment and using WSL’s built-in display server functionality, <ahref="https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps"target="_blank">WSLg</a>, for GUI support. The Linux version of GitKraken client has been updated to fix common issues when operating GitKraken within WSL 2, and includes settings to [set preferences](#preferences_for_wsl)for where to open web links and files opened by GitKraken running within WSL 2.
18
21
19
22
<divclass='callout callout--warning'>
20
-
<p>Note: GitKraken Client does not currently support cross file system access for repos stored on both Windows and WSL 2 and should be installed on the operating system where your repos are stored for the best experience. Opening repos across file systems </p>
23
+
<p>Note: GitKraken Client does not currently support cross file system access for repos stored on both Windows and WSL 2 and should be installed on the operating system where your repos are stored for the best experience. Opening repos across file systems may severly degrade performance and features may not work as intended.</p>
21
24
</div>
22
25
23
-
GitKraken Client will also detect where a repo is stored and allow you to open it in the proper version of GitKraken Client so you can better manage GitKraken when working with both Windows and WSL repos. For more information, see the section on <ahref=""> </a>.
26
+
GitKraken Client will also detect where a repo is stored and allow you to open it in the proper version of GitKraken Client so you can better manage GitKraken when working with both Windows and WSL repos. For more information, see the section on [Working Across File Systems](#working_across_file_systems).
24
27
25
28
There are 4 steps to start using GitKraken Client with your WSL repos:
26
29
1. Confirm the latest version of WSL 2 is installed that supports WSLg
@@ -72,21 +75,23 @@ To open GitKraken Client within WSL, you can always run the following command fr
72
75
```
73
76
gitkraken
74
77
```
75
-
Note: If you choose to install GitKraken Client from the .tar.gz file, gitkraken must be installed on ```PATH``` for this command to work
78
+
Note: If you choose to install GitKraken Client from the .tar.gz file, gitkraken must be installed on `PATH` for this command to work
76
79
***
77
80
81
+
<divid="preferences_for_wsl"></div>
82
+
78
83
## Preferences for GitKraken on WSL 2
79
84
80
-
When running GitKraken Client within WSL 2, additional preferences are available to tell GitKraken where you'd like to open URLs and files opened by GitKraken. You'll see these settings in ```Preferences``` > ```General``` when running within WSL 2.
85
+
When running GitKraken Client within WSL 2, additional preferences are available to tell GitKraken where you'd like to open URLs and files opened by GitKraken. You'll see these settings in `Preferences` > `General` when running within WSL 2.
By default, URLs will open in your Windows default browser and other files opened by GitKraken will attempt to open on the host distribution.
85
90
86
91
## Known Issues
87
92
88
-
- <ahref=""target="_blank">HiDPI Displays cause WSLg to inconsistently scale the UI</a>
89
-
- <ahref=""target="_blank">Window snapping does not work with WSLg</a>
93
+
- <ahref="https://github.com/microsoft/wslg/issues/388"target="_blank">HiDPI Displays cause WSLg to inconsistently scale the UI</a>
94
+
- <ahref="https://github.com/microsoft/wslg/issues/727"target="_blank">Window snapping does not work with WSLg</a>
90
95
91
96
## Troubleshooting
92
97
@@ -99,18 +104,19 @@ wsl --shutdown
99
104
Then, reopen your Linux distribution or GitKraken Client as administrator.
100
105
***
101
106
107
+
<divid="working_across_file_systems"></div>
102
108
## Working Across File Systems
103
109
104
110
Microsoft recommends against working across operating systems when using WSL 2, and GitKraken does not currently support cross file system access of repos. To better manage multiple installations of GitKraken, GitKraken will notify you when opening a repo across operating systems and allow you to directly open the repo in the recommended installation of GitKraken. When attempting to open a new repo that is on WSL 2 from GitKraken installed on Windows, or Windows from GitKraken installed on WSL 2, the following message will appear:
-```Open Help Center``` will take you to this page in your browser for information on how to set up GitKraken within WSL 2.
115
+
-`Open Help Center` will take you to this page in your browser for information on how to set up GitKraken within WSL 2.
110
116
111
-
-```Open with GitKraken on Ubuntu/Windows``` will open the repository you're attempting to open in the recommended version of GitKraken if installed in the operating system where the repository is stored. This will work for both Windows and WSL 2 repositories that are being access from a different operating system.
117
+
-`Open with GitKraken on Ubuntu/Windows` will open the repository you're attempting to open in the recommended version of GitKraken if installed in the operating system where the repository is stored. This will work for both Windows and WSL 2 repositories that are being access from a different operating system.
112
118
113
-
-```Open Anyway``` will open the repository. Features may behave in unintended ways, simply not function, and performance may be severely degraded when opening from a different operating system.
119
+
-`Open Anyway` will open the repository. Features may behave in unintended ways, simply not function, and performance may be severely degraded when opening from a different operating system.
114
120
115
121
- Closing the message will cancel opening the repository
0 commit comments