From 6d284804359e13ea7d9b382afacac1f3d8342cdc Mon Sep 17 00:00:00 2001 From: Kristopher Wuollett Date: Thu, 20 Jul 2023 10:58:58 -0500 Subject: [PATCH] Document crate-type lib requirement for generate-sources - previously crate-type lib seemed optional - fixes #173 --- README.md | 2 +- guide/src/introduction/quickstart.md | 2 +- guide/src/usage/cargo-toml.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20b133f4e0..89a3babf3a 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,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/introduction/quickstart.md b/guide/src/introduction/quickstart.md index c5cdfdae94..66a66eb0e7 100644 --- 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 index 0c8c3ad843..0232027666 100644 --- 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. ] ```