Skip to content

Commit 6aa2376

Browse files
committed
Linting corrections from Saibamen
1 parent ba03aab commit 6aa2376

File tree

2 files changed

+14
-11
lines changed

2 files changed

+14
-11
lines changed

.github/workflows/build.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ jobs:
4444

4545
- name: Prepare files for upload
4646
run: |
47-
4847
mkdir upload
4948
mkdir upload/${{ matrix.win_arch }}
5049
@@ -54,7 +53,6 @@ jobs:
5453
copy build/mkbtrfs.exe upload/${{ matrix.win_arch }}
5554
copy build/btrfs.sys upload/${{ matrix.win_arch }}
5655
57-
5856
mkdir upload-pdb
5957
mkdir upload-pdb/${{ matrix.win_arch }}
6058

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Compilation
141141

142142
To compile with Visual C++ 2019, open the directory and let CMake do its thing.
143143
If you have the Windows DDK installed correctly, it should just work.
144-
Note : you need to use the Ninja generator for CMake, else the driver might not work once installed
144+
Note: you need to use the Ninja generator for CMake, else the driver might not work once installed
145145

146146
To compile with GCC on Linux, you will need a cross-compiler set up, for either
147147
`i686-w64-mingw32` or `x86_64-w64-mingw32`. Create a build directory, then use
@@ -150,13 +150,15 @@ generate your Makefile.
150150

151151
Signing
152152
-----------
153-
To install a built-from-source or a nightly (from github actions) driver, you need to sign it
154-
In this section, I will show how to disable driver signature enforcement, or how to sign the driver using test-signing
155-
Warning : both of these solutions aren't perfect, if you are looking for a everyday-use it is recommanded to use the release builds, which are signed with a Microsoft-trusted key.
153+
154+
To install a built-from-source or a nightly (from github actions) driver, you need to sign it.
155+
In this section, I will show how to disable driver signature enforcement, or how to sign the driver using test-signing.
156+
Warning: both of these solutions aren't perfect, if you are looking for a everyday-use it is recommanded to use the release builds, which are signed with a Microsoft-trusted key.
156157

157158

158159
## Disabling signature enforcement
159-
Note : this isn't persistent accross reboots
160+
161+
Note: this isn't persistent accross reboots
160162

161163
Relevant link : https://docs.microsoft.com/en-us/windows-hardware/drivers/install/installing-an-unsigned-driver-during-development-and-test
162164

@@ -175,27 +177,30 @@ If the window didn't show up, the driver probably wasn't installed, make sure yo
175177
The computer should next tell you to reboot your computer
176178

177179
### 3 - Reboot the computer again without driver signature enforcement
180+
178181
Follow the same instructions as step 1
179182

180183
### 4 - Done !
184+
181185
The driver should now be installed ! Note it will only load when the computer is started without driver signature enforcement
182186

183187

184188

185189
## Test-signing the driver
186-
Note : This method is harder to put in place, and has the only benefit of persisting after reboots.
190+
191+
Note: This method is harder to put in place, and has the only benefit of persisting after reboots.
187192

188193
Example commands are given for each steps but it is recommand to check the microsoft documentation link about test-signing, so you know what you are doing
189194

190-
Relevant link : https://docs.microsoft.com/en-us/windows-hardware/drivers/install/test-signing
195+
Relevant link: https://docs.microsoft.com/en-us/windows-hardware/drivers/install/test-signing
191196

192197
### 1 - Put your computer in test mode
193198

194199
test-signing doesn't seem to work with Windows by default. You will need to put your computer in a special mode to allow test-signing.
195200

196201
`bcdedit /set testsigning on`
197202

198-
Note : you might need to disable Secure Boot for this to work
203+
Note: you might need to disable Secure Boot for this to work
199204

200205
### 2 - Generate a MakeCert certificate
201206

@@ -218,7 +223,7 @@ The command will differ in your case (because of the path) but here is the one I
218223

219224
`"C:\Program Files (x86)\Windows Kits\10\bin\x86\Inf2Cat.exe" /os:10_NI_X64 /driver:.`
220225

221-
Note : this was tested in Windows 11, you might need to change the values of the /os flag according to your Windows version
226+
Note: this was tested in Windows 11, you might need to change the values of the /os flag according to your Windows version
222227

223228
### 5 - Sign the catalog file
224229

0 commit comments

Comments
 (0)