Add option to include debug symbols (#123)

rust-cross · Aug 5, 2024 · 13af951 · 13af951
1 parent 871bd27
commit 13af951
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -54,13 +54,14 @@ for example, `cargo xwin test --target x86_64-pc-windows-msvc`
 
 The Microsoft CRT and Windows SDK can be customized using the following environment variables or CLI options.
 
-| Environment Variable      | CLI option                  | Description                                                                                                        |
-| ------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------ |
-| `XWIN_ARCH`               | `--xwin-arch`               | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64           |
-| `XWIN_VARIANT`            | `--xwin-variant`            | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre                         |
-| `XWIN_VERSION`            | `--xwin-version`            | The version to retrieve, defaults to 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |
-| `XWIN_CACHE_DIR`          | `--xwin-cache-dir`          | xwin cache directory to put CRT and SDK files                                                                      |
-| `XWIN_INCLUDE_DEBUG_LIBS` | `--xwin-include-debug-libs` | Whether or not to include debug libs in installation (default false).                                              |
+| Environment Variable         | CLI option                     | Description                                                                                                        |
+| ---------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+| `XWIN_ARCH`                  | `--xwin-arch`                  | The architectures to include, defaults to `x86_64,aarch64`, possible values: x86, x86_64, aarch, aarch64           |
+| `XWIN_VARIANT`               | `--xwin-variant`               | The variants to include, defaults to `desktop`, possible values: desktop, onecore, spectre                         |
+| `XWIN_VERSION`               | `--xwin-version`               | The version to retrieve, defaults to 16, can either be a major version of 15 or 16, or a `<major>.<minor>` version |
+| `XWIN_CACHE_DIR`             | `--xwin-cache-dir`             | xwin cache directory to put CRT and SDK files                                                                      |
+| `XWIN_INCLUDE_DEBUG_LIBS`    | `--xwin-include-debug-libs`    | Whether or not to include debug libs in installation (default false).                                              |
+| `XWIN_INCLUDE_DEBUG_SYMBOLS` | `--xwin-include-debug-symbols` | Whether or not to include debug symbols (PDBs) in installation (default false).                                    |
 
 ### CMake Support
 

diff --git a/src/common.rs b/src/common.rs
@@ -54,6 +54,10 @@ pub struct XWinOptions {
     /// Whether or not to include debug libs
     #[arg(long, env = "XWIN_INCLUDE_DEBUG_LIBS", hide = true)]
     pub xwin_include_debug_libs: bool,
+
+    /// Whether or not to include debug symbols (PDBs)
+    #[arg(long, env = "XWIN_INCLUDE_DEBUG_SYMBOLS", hide = true)]
+    pub xwin_include_debug_symbols: bool,
 }
 
 impl Default for XWinOptions {
@@ -64,6 +68,7 @@ impl Default for XWinOptions {
             xwin_variant: vec![xwin::Variant::Desktop],
             xwin_version: "16".to_string(),
             xwin_include_debug_libs: false,
+            xwin_include_debug_symbols: false,
         }
     }
 }
@@ -295,7 +300,7 @@ impl XWinOptions {
         let pruned = xwin::prune_pkg_list(&pkg_manifest, arches, variants, false, None, None)?;
         let op = xwin::Ops::Splat(xwin::SplatConfig {
             include_debug_libs: self.xwin_include_debug_libs,
-            include_debug_symbols: false,
+            include_debug_symbols: self.xwin_include_debug_symbols,
             enable_symlinks: !cfg!(target_os = "macos"),
             preserve_ms_arch_notation: false,
             use_winsysroot_style: false,