Skip to content

docs: add missing wdk.sign.digest_algorithm description #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 17, 2025
Merged

docs: add missing wdk.sign.digest_algorithm description #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/api/description/project-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2630,6 +2630,7 @@ The following is a list of some built-in extended configuration items currently
| wdk.sign.store | Set wdk code signing store |
| wdk.sign.certfile | Set wdk code signing certificate file |
| wdk.sign.thumbprint | Set wdk code signing fingerprint |
| wdk.sign.digest_algorithm | Set wdk code signing digest algorithm |
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The alignment of this new table row is inconsistent with the rows above it. For better readability and maintainability, please adjust the spacing to align the columns.

Suggested change
| wdk.sign.digest_algorithm | Set wdk code signing digest algorithm |
| wdk.sign.digest_algorithm | Set wdk code signing digest algorithm |


## add_values

Expand Down
4 changes: 4 additions & 0 deletions docs/examples/cpp/wdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ We can use test certificate of xmake to do testsign, but please run `$xmake l ut
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.digest_algorithm", "sha256")
```

Or we set a valid certificate thumbprint to do it in local machine.
Expand All @@ -102,6 +103,7 @@ target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.thumbprint", "032122545DCAA6167B1ADBE5F7FDF07AE2234AAA")
set_values("wdk.sign.digest_algorithm", "sha256")
```

We can also do testsign via setting store/company info.
Expand All @@ -112,6 +114,7 @@ target("msdsm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.store", "PrivateCertStore")
set_values("wdk.sign.company", "tboox.org(test)")
set_values("wdk.sign.digest_algorithm", "sha256")
```

### ReleaseSign
Expand All @@ -124,6 +127,7 @@ target("msdsm")
set_values("wdk.sign.mode", "release")
set_values("wdk.sign.company", "xxxx")
set_values("wdk.sign.certfile", path.join(os.projectdir(), "xxxx.cer"))
set_values("wdk.sign.digest_algorithm", "sha256")
```

## Support Low-version System
Expand Down
35 changes: 18 additions & 17 deletions docs/zh/api/description/project-target.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2600,23 +2600,24 @@ target("test")

下面是一些 xmake 目前支持的一些内置的扩展配置项列表。

| 扩展配置名 | 配置描述 |
| --- | --- |
| fortran.moduledir | 设置 fortran 模块的输出目录 |
| ndk.arm_mode | 设置 ndk 的 arm 编译模式（arm/thumb） |
| objc.build.arc | 设置启用或禁用 objc 的 arc |
| objc++.build.arc | 设置启用或禁用 objc++ 的 arc |
| xcode.bundle_identifier | 设置 xcode 工具链的 Bundle Identifier |
| xcode.mobile_provision | 设置 xcode 工具链的证书信息 |
| xcode.codesign_identity | 设置 xcode 工具链的代码签名标识 |
| wasm.preloadfiles | 设置 wasm 打包的预加载文件（preload file） |
| wdk.env.winver | 设置 wdk 的 win 支持版本 |
| wdk.umdf.sdkver | 设置 wdk 的 umdf sdk 版本 |
| wdk.kmdf.sdkver | 设置 wdk 的 kmdf sdk 版本 |
| wdk.sign.mode | 设置 wdk 的代码签名模式 |
| wdk.sign.store | 设置 wdk 的代码签名 store |
| wdk.sign.certfile | 设置 wdk 的代码签名证书文件 |
| wdk.sign.thumbprint | 设置 wdk 的代码签名指纹 |
| 扩展配置名 | 配置描述 |
| --- | --- |
| fortran.moduledir | 设置 fortran 模块的输出目录 |
| ndk.arm_mode | 设置 ndk 的 arm 编译模式 (arm/thumb) |
| objc.build.arc | 设置启用或禁用 objc 的 arc |
| objc++.build.arc | 设置启用或禁用 objc++ 的 arc |
| xcode.bundle_identifier | 设置 xcode 工具链的 Bundle Identifier |
| xcode.mobile_provision | 设置 xcode 工具链的证书信息 |
| xcode.codesign_identity | 设置 xcode 工具链的代码签名标识 |
| wasm.preloadfiles | 设置 wasm 打包的预加载文件 (preload file) |
| wdk.env.winver | 设置 wdk 的 win 支持版本 |
| wdk.umdf.sdkver | 设置 wdk 的 umdf sdk 版本 |
| wdk.kmdf.sdkver | 设置 wdk 的 kmdf sdk 版本 |
| wdk.sign.mode | 设置 wdk 的代码签名模式 |
| wdk.sign.store | 设置 wdk 的代码签名 store |
| wdk.sign.certfile | 设置 wdk 的代码签名证书文件 |
| wdk.sign.thumbprint | 设置 wdk 的代码签名指纹 |
| wdk.sign.digest_algorithm | 设置 wdk 的代码签名摘要算法 |
Comment on lines +2603 to +2620
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The alignment of this table is inconsistent, making it difficult to read. Please reformat the table to properly align the columns. Consistent formatting improves readability and maintainability of the documentation.

Suggested change
| 扩展配置名 | 配置描述 |
| --- | --- |
| fortran.moduledir | 设置 fortran 模块的输出目录 |
| ndk.arm_mode | 设置 ndk 的 arm 编译模式 (arm/thumb) |
| objc.build.arc | 设置启用或禁用 objc 的 arc |
| objc++.build.arc | 设置启用或禁用 objc++ 的 arc |
| xcode.bundle_identifier | 设置 xcode 工具链的 Bundle Identifier |
| xcode.mobile_provision | 设置 xcode 工具链的证书信息 |
| xcode.codesign_identity | 设置 xcode 工具链的代码签名标识 |
| wasm.preloadfiles | 设置 wasm 打包的预加载文件 (preload file) |
| wdk.env.winver | 设置 wdk 的 win 支持版本 |
| wdk.umdf.sdkver | 设置 wdk 的 umdf sdk 版本 |
| wdk.kmdf.sdkver | 设置 wdk 的 kmdf sdk 版本 |
| wdk.sign.mode | 设置 wdk 的代码签名模式 |
| wdk.sign.store | 设置 wdk 的代码签名 store |
| wdk.sign.certfile | 设置 wdk 的代码签名证书文件 |
| wdk.sign.thumbprint | 设置 wdk 的代码签名指纹 |
| wdk.sign.digest_algorithm | 设置 wdk 的代码签名摘要算法 |
| 扩展配置名 | 配置描述 |
| ------------------------- | ---------------------------------------- |
| fortran.moduledir | 设置 fortran 模块的输出目录 |
| ndk.arm_mode | 设置 ndk 的 arm 编译模式 (arm/thumb) |
| objc.build.arc | 设置启用或禁用 objc 的 arc |
| objc++.build.arc | 设置启用或禁用 objc++ 的 arc |
| xcode.bundle_identifier | 设置 xcode 工具链的 Bundle Identifier |
| xcode.mobile_provision | 设置 xcode 工具链的证书信息 |
| xcode.codesign_identity | 设置 xcode 工具链的代码签名标识 |
| wasm.preloadfiles | 设置 wasm 打包的预加载文件 (preload file) |
| wdk.env.winver | 设置 wdk 的 win 支持版本 |
| wdk.umdf.sdkver | 设置 wdk 的 umdf sdk 版本 |
| wdk.kmdf.sdkver | 设置 wdk 的 kmdf sdk 版本 |
| wdk.sign.mode | 设置 wdk 的代码签名模式 |
| wdk.sign.store | 设置 wdk 的代码签名 store |
| wdk.sign.certfile | 设置 wdk 的代码签名证书文件 |
| wdk.sign.thumbprint | 设置 wdk 的代码签名指纹 |
| wdk.sign.digest_algorithm | 设置 wdk 的代码签名摘要算法 |


## add_values

Expand Down
4 changes: 4 additions & 0 deletions docs/zh/examples/cpp/wdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ $ xmake [p|package] -o outputdir
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.digest_algorithm", "sha256")
```

不过这种情况下，需要用户手动在管理员模式下，执行一遍：`$xmake l utils.wdk.testcert install`，来生成和注册test证书到本机环境。
Expand All @@ -107,6 +108,7 @@ target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.thumbprint", "032122545DCAA6167B1ADBE5F7FDF07AE2234AAA")
set_values("wdk.sign.digest_algorithm", "sha256")
```

从store/company来选择合适的证书进行签名：
Expand All @@ -117,6 +119,7 @@ target("msdsm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.store", "PrivateCertStore")
set_values("wdk.sign.company", "tboox.org(test)")
set_values("wdk.sign.digest_algorithm", "sha256")
```

### 正式签名 {#sign}
Expand All @@ -129,6 +132,7 @@ target("msdsm")
set_values("wdk.sign.mode", "release")
set_values("wdk.sign.company", "xxxx")
set_values("wdk.sign.certfile", path.join(os.projectdir(), "xxxx.cer"))
set_values("wdk.sign.digest_algorithm", "sha256")
```

## 生成低版本驱动 {#low-version-driver}
Expand Down
4 changes: 4 additions & 0 deletions docs/zh/posts/support-wdk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ $ xmake [p|package] -o outputdir
target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.digest_algorithm", "sha256")
add_files("src/*.c")
```

Expand All @@ -211,6 +212,7 @@ target("msdsm")
add_rules("wdk.driver", "wdk.env.wdm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.thumbprint", "032122545DCAA6167B1ADBE5F7FDF07AE2234AAA")
set_values("wdk.sign.digest_algorithm", "sha256")
add_files("src/*.c")
```

Expand All @@ -222,6 +224,7 @@ target("msdsm")
set_values("wdk.sign.mode", "test")
set_values("wdk.sign.store", "PrivateCertStore")
set_values("wdk.sign.company", "tboox.org(test)")
set_values("wdk.sign.digest_algorithm", "sha256")
add_files("src/*.c")
```

Expand All @@ -235,6 +238,7 @@ target("msdsm")
set_values("wdk.sign.mode", "release")
set_values("wdk.sign.company", "xxxx")
set_values("wdk.sign.certfile", path.join(os.projectdir(), "xxxx.cer"))
set_values("wdk.sign.digest_algorithm", "sha256")
```

## 生成低版本驱动
Expand Down