Skip to content

Commit e110468

Browse files
add intro section and cleaned links
1 parent cf26f5b commit e110468

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

gitkraken-client/windows-subsystem-for-linux.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,21 @@ taxonomy:
99

1010
## Working with WSL 2
1111

12-
<a href="https://learn.microsoft.com/en-us/windows/wsl/about" target="_blank">Windows Subsystem for Linux (WSL)</a>
12+
<a href="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. <a href="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.
1316

1417
## How to User GitKraken Client with WSL 2
1518
<img src="/wp-content/uploads/wsl-full-screen.png" srcset="/wp-content/uploads/[email protected]" class="img-bordered img-responsive center">
1619

17-
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, <a href="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, <a href="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.
1821

1922
<div class='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>
2124
</div>
2225

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 <a href=""> </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).
2427

2528
There are 4 steps to start using GitKraken Client with your WSL repos:
2629
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
7275
```
7376
gitkraken
7477
```
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
7679
***
7780

81+
<div id="preferences_for_wsl"></div>
82+
7883
## Preferences for GitKraken on WSL 2
7984

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.
8186

8287
<img src="/wp-content/uploads/wsl-host-settings.png" srcset="/wp-content/uploads/[email protected]" class="img-bordered img-responsive center">
8388

8489
By default, URLs will open in your Windows default browser and other files opened by GitKraken will attempt to open on the host distribution.
8590

8691
## Known Issues
8792

88-
- <a href="" target="_blank">HiDPI Displays cause WSLg to inconsistently scale the UI</a>
89-
- <a href="" target="_blank">Window snapping does not work with WSLg</a>
93+
- <a href="https://github.com/microsoft/wslg/issues/388" target="_blank">HiDPI Displays cause WSLg to inconsistently scale the UI</a>
94+
- <a href="https://github.com/microsoft/wslg/issues/727" target="_blank">Window snapping does not work with WSLg</a>
9095

9196
## Troubleshooting
9297

@@ -99,18 +104,19 @@ wsl --shutdown
99104
Then, reopen your Linux distribution or GitKraken Client as administrator.
100105
***
101106

107+
<div id="working_across_file_systems"></div>
102108
## Working Across File Systems
103109

104110
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:
105111

106112
<img src="/wp-content/uploads/wsl-toast.png" srcset="/wp-content/uploads/[email protected]" class="img-bordered img-responsive center">
107113

108114
You will be asked to choose an option to proceed:
109-
- ```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.
110116

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.
112118

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.
114120

115121
- Closing the message will cancel opening the repository
116122

0 commit comments

Comments
 (0)