[documentation] #2113: Document features in Cargo.toml files

Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>

actor/Cargo.toml

@@ -8,6 +8,7 @@ edition = "2021"
 
 [features]
 default = []
+# Enable deadlock detection
 deadlock_detection = ["petgraph"]
 
 [dependencies]

cli/Cargo.toml

@@ -14,11 +14,20 @@ categories = ["cryptography::cryptocurrencies"]
 [features]
 default = ["bridge", "telemetry", "schema-endpoint"]
 
+# Support interoperability with popular blockchain networks (Substrate, Ether, etc.)
 bridge = ["iroha_core/bridge"]
+# Support Decentralised Exchange, including functionality for atomic exchange instruction
 dex = ["iroha_core/dex"]
+# Support lightweight telemetry, including diagnostics
 telemetry = ["iroha_telemetry", "iroha_core/telemetry"]
+# Support developer-specific telemetry.
+# Should not be enabled on production builds.
 dev-telemetry = ["iroha_core/dev-telemetry", "iroha_telemetry"]
+# Support schema generation from the `schema` endpoint in the local binary.
+# Useful for debugging issues with decoding in SDKs.
 schema-endpoint = ["iroha_schema_gen"]
+# Support internal testing infrastructure for integration tests.
+# Disable in production.
 test-network = []
 
 [badges]

core/Cargo.toml

@@ -14,11 +14,18 @@ categories = ["cryptography::cryptocurrencies"]
 [features]
 default = ["bridge", "cli", "telemetry"]
 
+# Interoperability with popular blockchain networks (Substrate, Ether, etc.)
 bridge = []
+# Support lightweight telemetry, including diagnostics
 telemetry = []
+# Support the included CLI
 cli = []
+# Support Decentralised Exchange, including functionality for atomic exchange instruction
 dex = []
+# Support developer-specific telemetry.
+# Should not be enabled on production builds.
 dev-telemetry = ["telemetry", "iroha_telemetry/dev-telemetry"]
+# Support Prometheus metrics. See https://prometheus.io/.
 expensive-telemetry = ["iroha_telemetry/metric-instrumentation"]
 
 [badges]

core/test_network/Cargo.toml

@@ -6,7 +6,9 @@ edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [features]
+# Enable mock tests
 mock = []
+# Create a mock query for testing
 query = []
 
 [dependencies]

futures/Cargo.toml

@@ -8,6 +8,7 @@ edition = "2021"
 
 [features]
 default = []
+# Support lightweight telemetry, including diagnostics
 telemetry = ["iroha_futures_derive/telemetry"]
 
 [dependencies]

futures/derive/Cargo.toml

@@ -6,6 +6,7 @@ edition = "2021"
 
 [features]
 default = ["telemetry"]
+# Support lightweight telemetry, including diagnostics
 telemetry = []
 
 [lib]

telemetry/Cargo.toml

@@ -6,7 +6,10 @@ edition = "2021"
 build = "build.rs"
 
 [features]
+# Support developer-specific telemetry.
+# Should not be enabled on production builds.
 dev-telemetry = []
+# Export Prometheus metrics. See https://prometheus.io/.
 metric-instrumentation = []
 
 [dependencies]

tools/kagami/Cargo.toml

@@ -14,8 +14,12 @@ edition = "2021"
 # be fixed soon.
 [features]
 default = ["dex", "telemetry", "dev-telemetry"]
+# Support Decentralised Exchange, including functionality for atomic exchange instruction
 dex = ["iroha_core/dex"]
+# Support lightweight telemetry, including diagnostics
 telemetry = ["iroha_core/telemetry"]
+# Support developer-specific telemetry.
+# Should not be enabled on production builds.
 dev-telemetry = ["iroha_core/dev-telemetry"]
 
 

tools/parity_scale_decoder/Cargo.toml

@@ -7,6 +7,8 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
+# Disable colour for all program output.
+# Useful for Docker-based deployment and terminals without colour support.
 no-color = ["colored/no-color"]
 
 [dependencies]

version/Cargo.toml

@@ -9,10 +9,13 @@ edition = "2021"
 [features]
 default = ["std", "derive", "scale", "json"]
 # Enable static linkage of the rust standard library.
-# Please refer to https://docs.rust-embedded.org/book/intro/no-std.html
+# Please refer to https://docs.rust-embedded.org/book/intro/no-std.html.
 std = ["iroha_macro/std", "parity-scale-codec/std", "thiserror"]
+# Enable macros for versioning
 derive = ["iroha_version_derive"]
+# Support SCALE codec for encoding and decoding
 scale = ["parity-scale-codec/full"]
+# Support JSON (de)serialisation
 json = ["serde", "serde_json"]
 
 [dependencies]