Skip to content

Commit 493e860

Browse files
00xcandreeaflorescu
authored andcommitted
Build docs.rs documentation with features enabled
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>
1 parent 35cb0d0 commit 493e860

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# Upcoming version
2+
3+
## Changed
4+
5+
- Added all features to the generated docs.rs documentation.
6+
17
# [v0.10.0]
28

39
## Changed

Cargo.toml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ homepage = "https://github.com/rust-vmm/linux-loader"
1515
readme = "README.md"
1616
autobenches = false
1717

18+
[package.metadata.docs.rs]
19+
all-features = true
20+
rustdoc-args = ["--cfg", "docsrs"]
21+
1822
[features]
1923
default = ["elf", "pe"]
2024
bzimage = []

src/lib.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
// SPDX-License-Identifier: Apache-2.0 AND BSD-3-Clause
99

1010
#![deny(missing_docs)]
11+
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
1112

1213
//! A Linux kernel image loading crate.
1314
//!

0 commit comments

Comments
 (0)