feat: in-manifest and in-lib documentation of features (#329)

Author: Byron

Cargo.lock

@@ -138,15 +138,7 @@ All feature toggles are additive.
 
 ### git-packetline
 
-By default, all IO related capabilities will be missing unless one of the following is chosen.
-
-* _mutually exclusive_
-    - Specifying both causes a compile error, preventing the use of `--all-features`.
-  * **blocking-io**
-    * If set, all IO will become blocking. The same types will be used preventing side-by-side usage of blocking and non-blocking IO
-  * **async-io**
-    * Implement IO traits from `futures-io` 
-    
+Documented in [its documentation](https://docs.rs/git-packetline).
 
 ### git-transport
 

cargo-features.md

@@ -12,11 +12,20 @@ include = ["src/**/*", "CHANGELOG.md"]
 doctest = false
 
 [features]
+#! By default, all IO related capabilities will be missing unless one of the following is chosen.
 default = []
+
+#! ### _Mutually exclusive_
+#! Specifying both causes a compile error, preventing the use of `--all-features`.
+
+## If set, all IO will become blocking. The same types will be used preventing side-by-side usage of blocking and non-blocking IO.
+blocking-io = []
+## Implement IO traits from `futures-io`.
+async-io = ["futures-io", "futures-lite", "pin-project-lite"]
+
+#! ### Other
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde1 = ["serde", "bstr/serde1"]
-async-io = ["futures-io", "futures-lite", "pin-project-lite"]
-blocking-io = []
 
 [[test]]
 name = "async-packetline"
@@ -41,8 +50,13 @@ futures-io = { version = "0.3.16", optional = true }
 futures-lite = { version  = "1.12.0", optional = true }
 pin-project-lite = { version = "0.2.6", optional = true }
 
+document-features = { version = "0.1", optional = true }
+
 [dev-dependencies]
 git-odb = { path = "../git-odb" }
 git-hash = { path = "../git-hash" }
 async-std = { version = "1.9.0", features = ["attributes"] }
 maybe-async = "0.2.6"
+
+[package.metadata.docs.rs]
+features = ["document-features"]

git-packetline/Cargo.toml

@@ -1,6 +1,11 @@
 //! Read and write the git packet line wire format without copying it.
 //!
 //! For reading the packet line format use the [`StreamingPeekableIter`], and for writing the [`Writer`].
+//! ## Feature Flags
+#![cfg_attr(
+    feature = "document-features",
+    cfg_attr(doc, doc = ::document_features::document_features!())
+)]
 #![deny(unsafe_code, rust_2018_idioms, missing_docs)]
 
 const U16_HEX_BYTES: usize = 4;