aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2022-07-08 11:07:52 +0900
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>2022-07-08 11:07:52 +0900
commitfc5dabae372f357fb5c4456fc5712032ff417511 (patch)
tree9be3fbe7b4954a7adcdd15930cd7ec18afc67b08
parent1b5fbf99c31e85ff408f042f30573da4d157482c (diff)
downloadhinoko-rs-fc5dabae372f357fb5c4456fc5712032ff417511.tar.gz
hinoko: support dox feature to suppress linking at documentation
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r--hinoko/Cargo.toml6
-rw-r--r--hinoko/README.md8
2 files changed, 13 insertions, 1 deletions
diff --git a/hinoko/Cargo.toml b/hinoko/Cargo.toml
index 62d04ea..838d985 100644
--- a/hinoko/Cargo.toml
+++ b/hinoko/Cargo.toml
@@ -12,6 +12,8 @@ homepage = "https://alsa-project.github.io/gobject-introspection-docs/"
keywords = ["ieee1394", "firewire", "linux", "glib"]
license = "MIT"
repository = "https://github.com/takaswie/hinoko-rs/"
+[package.metadata.docs.rs]
+features = ["dox"]
[lib]
name = "hinoko"
@@ -25,3 +27,7 @@ ffi = {package = "hinoko-sys", path = "../hinoko-sys", version = "0.0.90"}
[dev-dependencies]
gir-format-check = "^0.1"
once_cell = "1.5"
+
+[features]
+# To suppress linking to C library to generate documentation.
+dox = ["ffi/dox", "glib/dox"]
diff --git a/hinoko/README.md b/hinoko/README.md
index ceecf29..f9012b9 100644
--- a/hinoko/README.md
+++ b/hinoko/README.md
@@ -1,6 +1,6 @@
# hinoko crate
-Rust API bindings and wrappers for [hinoko library](https://github.com/alsa-project/libhinoko) to
+Rust API bindings and wrappers for [hinoko library](https://github.com/takaswie/libhinoko) to
operate Linux FireWire character device for isochronous packets and resources
in IEEE 1394 bus.
@@ -30,6 +30,12 @@ The hinoko crate is released under [MIT license](https://spdx.org/licenses/MIT.h
The hinoko crate depends on API crates provided by [gtk-rs project](https://gtk-rs.org/) for
type/object system, event loop, and dispacher.
+## Features for documentation
+
+* dox
+
+ * Suppress linking to hinoko library when generating documentation.
+
## Repository
The hinoko-sys crate is maintained by Takashi Sakamoto.