Skip to content

Commit cdff1ac

Browse files
feat: added troubleshooting advice for windows SCA issue (#302)
1 parent e6f86cc commit cdff1ac

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

pages/modernization-assessment.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,9 @@ You can learn more about the modernization potential of your applications by ana
100100

101101
Tidal Code Analysis is performed using our command-line software utility Tidal Tools. The software is available to download [here](https://get.tidal.sh/), and you can learn more about getting started with the tool in our guide [here](https://guides.tidal.cloud/tidal-tools.html).
102102

103+
{: .note }
104+
Tidal Source Code Analysis uses Docker under the hood. There is a [known issue](/troubleshooting.html#windows-source-code-analysis) with Docker where scanning a codebase hosted on a Windows file system will be very time consuming. If you are on Windows, we recommend hosting the sourse code which you will analyze on [WSL](https://learn.microsoft.com/en-us/windows/wsl/about).
105+
103106
Once you have Tidal Tools installed, run the following command and follow the prompts to authenticate with Accelerator.
104107

105108
`tidal login`

pages/troubleshooting/troubleshooting.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,14 @@ must escape the backslash character with another backslash (which is the escape
202202
character), so the string must be as the following: `C:\\Program Files\\Tidal
203203
Software\\tidal`.
204204

205+
### Source Code Analysis is slow when the source code is stored on Windows {#windows-source-code-analysis}
206+
207+
When running Tidal Source Code Analysis on codebases that are stored in a Windows filesystem, you might notice that the process is quite slow - especially on larger codebases.
208+
209+
The root cause of this issue is that since Source Code Analysis is running in a Linux container, accessing the Windows file system from within this container is very time-consuming.
210+
211+
For analyzing larger codebases on Windows, we recommend using [WSL](https://learn.microsoft.com/en-us/windows/wsl/about), and hosting the source code inside your WSL environment.
212+
205213
## Linux troubleshooting {#linux}
206214

207215
### Manage Docker as a non-root user {#docker-non-root}

0 commit comments

Comments
 (0)