Merge pull request #935 from newcomertv/quality/troubleshooting-linke…

…rissue-staticlib clarify setup for static libraries
knurling-rs · Feb 13, 2025 · 17fdb37 · 17fdb37
2 parents ac0bdfc + 3e9c2d3
commit 17fdb37
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -49,6 +49,7 @@ We have several packages which live in this repository. Changes are tracked sepa
 
 ### [defmt-next]
 
+* [#935] Add note in book's setup chapter to clarify staticlib setup
 * [#914] Add cargo-deny as a CI action to check crate security and licensing
 
 ### [defmt-v0.3.10] (2024-11-29)

diff --git a/book/src/setup.md b/book/src/setup.md
@@ -34,6 +34,10 @@ rustflags = [
 ]
 ```
 
+> Note :
+> If you intend on linking your project as a **static library** the linkerscript contents should be applied to the final binary.
+> Adding the `-C link-arg=` option to static libraries has no effect because they are only archived, not linked.
+
 ### `#[global_logger]`
 
 The application must link to or define a `global_logger`.