Introduce document-features feature (#1477)

libafl/Cargo.toml

@@ -17,6 +17,7 @@ all-features = true
 
 [features]
 default = ["std", "derive", "llmp_compression", "llmp_small_maps", "llmp_broker_timeouts", "rand_trait", "fork", "prelude", "gzip", "regex", "serdeany_autoreg", "tui_monitor"]
+document-features = ["dep:document-features"]
 
 #! # Feature Flags
 #! ### General Features
@@ -117,7 +118,7 @@ llmp_small_maps = ["libafl_bolts/llmp_small_maps"] # reduces initial map size fo
 
 #! ## License-Changing Dependencies(!)
 
-## Enables features hiding dependencies licensed under `AGPL`
+## Enables all features hiding dependencies licensed under `AGPL`
 agpl = ["nautilus"]
 
 ## Enables the [`Nautilus`](https://wcventure.github.io/FuzzingPaper/Paper/NDSS19_Nautilus.pdf) Grammar Mutator (AGPL-licensed)
@@ -176,7 +177,7 @@ libcasr = { version = "2.7", optional = true}
 serial_test = { version = "2", optional = true, default-features = false, features = ["logging"] }
 
 # Document all features of this crate (for `cargo doc`)
-document-features = { version = "0.2" }
+document-features = { version = "0.2", optional = true }
 
 # AGPL
 # !!! this create requires nightly

libafl/src/lib.rs

@@ -3,7 +3,7 @@ Welcome to `LibAFL`
 */
 #![doc = include_str!("../README.md")]
 /*! */
-#![doc = document_features::document_features!()]
+#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
 #![allow(incomplete_features)]
 #![no_std]
 // For `type_eq`

libafl_bolts/Cargo.toml

@@ -18,6 +18,7 @@ all-features = true
 
 [features]
 default = ["std", "derive", "llmp_compression", "llmp_small_maps", "rand_trait", "prelude", "gzip", "serdeany_autoreg", "alloc"]
+document-features = ["dep:document-features"]
 
 #! # Feature Flags
 #! ### General Features
@@ -112,7 +113,7 @@ pyo3 = { version = "0.18.3", optional = true, features = ["serde", "macros"] }
 serial_test = { version = "2", optional = true, default-features = false, features = ["logging"] }
 
 # Document all features of this crate (for `cargo doc`)
-document-features = { version = "0.2" }
+document-features = { version = "0.2", optional = true }
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2" # For (*nix) libc

libafl_bolts/src/lib.rs

@@ -3,7 +3,7 @@
 */
 #![doc = include_str!("../README.md")]
 /*! */
-#![doc = document_features::document_features!()]
+#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
 #![allow(incomplete_features)]
 #![no_std]
 // For `type_eq`

libafl_concolic/symcc_libafl/Cargo.toml

@@ -18,8 +18,10 @@ all-features = true
 
 [features]
 default = ["build", "clone"]
-build = ["which", "cmake"] # common functionality to build symcc
+## common functionality to build symcc
-clone = ["which"] # common functionality to check out the symcc repo using git
+build = ["which", "cmake"]
+## common functionality to check out the symcc repo using git
+clone = ["which"]
 
 [dependencies]
 which = { version = "4.4", optional = true }

libafl_concolic/symcc_runtime/Cargo.toml

@@ -18,7 +18,7 @@ categories = ["development-tools::testing", "emulators", "embedded", "os", "no-s
 all-features = true
 
 [features]
-# skips building and linking the C++ part of the runtime
+## skips building and linking the C++ part of the runtime
 no-cpp-runtime = []
 
 [dependencies]

libafl_libfuzzer/Cargo.toml

@@ -25,16 +25,16 @@ rustversion = "1.0"
 
 [features]
 #! ## Feature Flags
+document-features = ["dep:document-features"]
 
-## enables the derive macros for the arbitrary dependency, transparently forwarded from libfuzzer-sys
+## Enables the derive macros for the arbitrary dependency, transparently forwarded from libfuzzer-sys
 arbitrary-derive = ["libfuzzer-sys/arbitrary-derive"]
-## enables fuzzer introspection with LibAFL's `introspection` feature
+## Enables fuzzer introspection with LibAFL's `introspection` feature
 introspection = []
 
 [dependencies]
 libfuzzer-sys = { version = "0.4.7", default-features = false }
-
+document-features = { version = "0.2", optional = true }
-document-features = { version = "0.2" }
 
 [package.metadata.docs.rs]
 all-features = true

libafl_libfuzzer/libafl_libfuzzer_runtime/Cargo.toml

@@ -8,7 +8,8 @@ publish = false
 
 [features]
 default = ["fork", "serdeany_autoreg"]
-fork = ["libafl/fork"] # Enables forking mode for the LibAFL launcher (instead of starting new processes)
+## Enables forking mode for the LibAFL launcher (instead of starting new processes)
+fork = ["libafl/fork"]
 
 serdeany_autoreg = [] # TODO: drop this when fixed in libafl proper