Skip to content

Commit dc82161

Browse files
authored
Document various tips to iterate faster when building & deploying WSL (#14146)
1 parent 8aadbb4 commit dc82161

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

doc/docs/dev-loop.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,32 @@ See [debugging](debugging.md) for general debugging instructions.
7272

7373
To attach a debugger to the unit test process, use: `/waitfordebugger` when calling `test.bat`.
7474
Use `/breakonfailure` to automatically break on the first test failure.
75+
76+
## Tips and tricks
77+
78+
**Building and deploying faster**
79+
80+
To iterate faster, create a copy of [```UserConfig.cmake.sample```](https://github.com/microsoft/WSL/blob/master/UserConfig.cmake.sample):
81+
82+
```
83+
copy UserConfig.cmake.sample UserConfig.cmake
84+
```
85+
86+
And uncomment this line:
87+
88+
```
89+
# set(WSL_DEV_BINARY_PATH "C:/wsldev")
90+
```
91+
92+
This will change the build logic to build a smaller package that installs faster.
93+
Also see:
94+
95+
- `WSL_BUILD_THIN_PACKAGE` to build an even smaller package
96+
- `WSL_POST_BUILD_COMMAND` to automatically deploy the package during build
97+
98+
**Code formatting**
99+
100+
Every pull request needs to be clang-formatted before it can be merged.
101+
102+
The code can be manually formatted by running: `powershell .\FormatSource.ps1 -ModifiedOnly $false`.
103+
To automatically check formatting when creating a commit, run: `tools\SetupClangFormat.bat`

0 commit comments

Comments
 (0)