Document crate-type lib requirement for generate-sources (#174)

getditto · Sep 4, 2023 · 5976546 · 5976546
1 parent 0c5829a
commit 5976546
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -60,7 +60,8 @@ edition = "2021"
 crate-type = [
     "staticlib",  # Ensure it gets compiled as a (static) C library
   # "cdylib",     # If you want a shared/dynamic C library (advanced)
-    "lib",        # For downstream Rust dependents: `examples/`, `tests/` etc.
+    "lib",        # For `generate-headers` and other downstream rust dependents
+                  # such as integration `tests/`, doctests, and `examples/`
 ]
 
 [dependencies]

diff --git a/guide/src/introduction/quickstart.md b/guide/src/introduction/quickstart.md
@@ -29,7 +29,7 @@ edition = "2021"
 crate-type = [
     "staticlib",  # Ensure it gets compiled as a (static) C library
   # "cdylib",     # If you want a shared/dynamic C library (advanced)
-    "lib",        # For downstream Rust dependents: `examples/`, `tests/` etc.
+    "lib",        # For `generate-headers`, `examples/`, `tests/` etc.
 ]
 
 [dependencies]

diff --git a/guide/src/usage/cargo-toml.md b/guide/src/usage/cargo-toml.md
@@ -20,7 +20,7 @@ crate-type = [
     "cdylib",     # If you want a shared/dynamic C library (advanced)
                   # `target/{debug,release}/libcrate_name.{so,dylib}`
 
-    "lib",        # For downstream Rust dependents: `examples/`, `tests/` etc.
+    "lib",        # For `generate-headers`, `examples/`, `tests/` etc.
 ]
 ```