Skip to content

Commit

Permalink
Build docs.rs documentation with features enabled
Browse files Browse the repository at this point in the history
The current documentation build in docs.rs does not include
non-default crate features (at the moment just "bzimage"), which
might lead to users of the crate not being aware of their existence.

Signed-off-by: Carlos López <carlos.lopez@suse.com>
  • Loading branch information
00xc committed Nov 13, 2023
1 parent 35cb0d0 commit 26a0d86
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# Upcoming version

## Changed

- Added all features to the generated docs.rs documentation.

# [v0.10.0]

## Changed
Expand Down
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ homepage = "https://github.com/rust-vmm/linux-loader"
readme = "README.md"
autobenches = false

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[features]
default = ["elf", "pe"]
bzimage = []
Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
// SPDX-License-Identifier: Apache-2.0 AND BSD-3-Clause

#![deny(missing_docs)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

//! A Linux kernel image loading crate.
//!
Expand Down

0 comments on commit 26a0d86

Please sign in to comment.