SYS-OSS/FRET-LibAFL
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Do not build doc with all features. (#1928)

Browse Source 
Add documentation about default features for documentation.
This commit is contained in:
Romain Malmain 2024-03-12 23:08:37 +01:00 committed by GitHub
parent 5f67b9fbc4
commit 9b96149f6c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
libafl_qemu/Cargo.toml
View File

@ -12,8 +12,7 @@ edition = "2021"
categories = ["development-tools::testing", "emulators", "embedded", "os", "no-std"] categories = ["development-tools::testing", "emulators", "embedded", "os", "no-std"]
[package.metadata.docs.rs] [package.metadata.docs.rs]
features = ["document-features"] features = ["document-features", "default", "python", "x86_64", "usermode"]
all-features = true
rustdoc-args = ["--cfg", "docsrs"] rustdoc-args = ["--cfg", "docsrs"]
[features] [features]

4
libafl_qemu/libafl_qemu_sys/Cargo.toml
View File

@ -12,7 +12,7 @@ edition = "2021"
categories = ["development-tools::testing", "emulators", "embedded", "os", "no-std"] categories = ["development-tools::testing", "emulators", "embedded", "os", "no-std"]
[package.metadata.docs.rs] [package.metadata.docs.rs]
all-features = true features = ["x86_64", "usermode"]
rustdoc-args = ["--cfg", "docsrs"] rustdoc-args = ["--cfg", "docsrs"]
[features] [features]
@ -33,7 +33,7 @@ systemmode = []
slirp = [ "systemmode", "libafl_qemu_build/slirp" ] # build qemu with host libslirp (for user networking) slirp = [ "systemmode", "libafl_qemu_build/slirp" ] # build qemu with host libslirp (for user networking)
shared = [ "libafl_qemu_build/shared" ] shared = [ "libafl_qemu_build/shared" ]
clippy = [ "libafl_qemu_build/clippy" ] # special feature for clippy, don't use in normal projects§ clippy = [ "libafl_qemu_build/clippy" ] # special feature for clippy, don't use in normal projects
[dependencies] [dependencies]

7
libafl_qemu/libafl_qemu_sys/src/lib.rs
View File

@ -1,3 +1,10 @@
/*!
`libafl_qemu_sys` is the crate exporting C symbols from QEMU.
Have a look at `libafl_qemu` for higher-level abstractions.
__Warning__: The documentation is built by default for `x86_64` in `usermode`. To access the documentation of other architectures or systemmode, the documentation must be rebuilt with the right features.
*/
#![allow(non_upper_case_globals)] #![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)] #![allow(non_camel_case_types)]
#![allow(non_snake_case)] #![allow(non_snake_case)]

1
libafl_qemu/src/lib.rs
View File

@ -1,6 +1,7 @@
#![cfg_attr(nightly, feature(used_with_arg))] #![cfg_attr(nightly, feature(used_with_arg))]
//! Welcome to `LibAFL` QEMU //! Welcome to `LibAFL` QEMU
//! //!
//! __Warning__: The documentation is built by default for `x86_64` in `usermode`. To access the documentation of other architectures or `systemmode`, the documentation must be rebuilt with the right features.
#![doc = include_str!("../../README.md")] #![doc = include_str!("../../README.md")]
/*! */ /*! */
#![cfg_attr(feature = "document-features", doc = document_features::document_features!())] #![cfg_attr(feature = "document-features", doc = document_features::document_features!())]