Add additional configuration section to docs in packages that lacked this (#3827)

* Add `additional configuration` to docs in packages that lacked this

* update esp-backtrace doc

* address review

Co-authored-by: Dániel Buga <[email protected]>

* update the "greeting" entry

* conditioned "force frame pointers" entry

* oopsy

---------

Co-authored-by: Dániel Buga <[email protected]>

Author: playfulFence

esp-backtrace/Cargo.toml

@@ -25,6 +25,7 @@ esp-config  = { version = "0.5.0", path = "../esp-config" }
 esp-println = { version = "0.15.0", optional = true, default-features = false, path = "../esp-println" }
 heapless    = "0.8"
 semihosting = { version = "0.1.20", optional = true }
+document-features = "0.2.11"
 
 [build-dependencies]
 esp-config   = { version = "0.5.0", path = "../esp-config", features = ["build"] }
@@ -40,21 +41,27 @@ esp32h2 = ["esp-println?/esp32h2"]
 esp32s2 = ["esp-println?/esp32s2", "semihosting?/openocd-semihosting"]
 esp32s3 = ["esp-println?/esp32s3", "semihosting?/openocd-semihosting", "print-float-registers"]
 
-# Use esp-println
+## Use `esp-println`
 println = ["dep:esp-println"]
 
-# Use defmt
+## Use `defmt`
 defmt = ["dep:defmt"]
 
 print-float-registers = [] # TODO support esp32p4
 
 # You may optionally enable one or more of the below features to provide
 # additional functionality:
+## Print messages in red (only used for panic and exception handlers)
 colors               = []
+## Invoke the extern function custom_halt() instead of doing a loop {} in case of a panic or exception
 custom-halt          = []
+## Invoke the extern function `custom_pre_backtrace()` before handling a panic or exception
 custom-pre-backtrace = []
+## Include an exception handler, will add `esp-println` as a dependency
 exception-handler    = []
+## Halt both CPUs on ESP32 / ESP32-S3 instead of doing a `loop {}` in case of a panic or exception
 halt-cores           = []
+## Include a panic handler, will add `esp-println` as a dependency
 panic-handler        = []
 
 [lints.rust]

esp-backtrace/src/lib.rs

@@ -1,6 +1,26 @@
 #![allow(rustdoc::bare_urls, unused_macros)]
 #![cfg_attr(target_arch = "xtensa", feature(asm_experimental_arch))]
-#![doc = include_str!("../README.md")]
+//! This is a lightweight crate for obtaining backtraces during panics, exceptions, and hard faults
+//! on Espressif devices. It provides optional panic and exception handlers and supports a range of
+//! output options, all configurable through feature flags.
+#![cfg_attr(
+    target_arch = "riscv32",
+    doc = "Please note that you **need** to force frame pointers (i.e. `\"-C\", \"force-frame-pointers\",` in your `.cargo/config.toml`)"
+)]
+//! You can get an array of backtrace addresses (limited to 10 entries by default) via
+//! `arch::backtrace()` if you want to create a backtrace yourself (i.e. not using the panic or
+//! exception handler).
+//!
+//! ## Features
+#![doc = document_features::document_features!()]
+//! ## Additional configuration
+//!
+//! We've exposed some configuration options that don't fit into cargo
+//! features. These can be set via environment variables, or via cargo's `[env]`
+//! section inside `.cargo/config.toml`. Below is a table of tunable parameters
+//! for this crate:
+#![doc = ""]
+#![doc = include_str!(concat!(env!("OUT_DIR"), "/esp_backtrace_config_table.md"))]
 #![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]
 #![no_std]
 

esp-hal-embassy/src/lib.rs

@@ -35,7 +35,7 @@
 //! queue flavour, then you need to pass as many timers as you start executors.
 //! In other cases, you can pass a single timer.
 //!
-//! ## Configuration
+//! ## Additional Configuration
 //!
 //! You can configure the behaviour of the embassy runtime by using the
 //! following environment variables:

esp-ieee802154/src/lib.rs

@@ -17,6 +17,14 @@
 //!
 //! ## Feature Flags
 #![doc = document_features::document_features!()]
+//! ## Additional configuration
+//!
+//! We've exposed some configuration options that don't fit into cargo
+//! features. These can be set via environment variables, or via cargo's `[env]`
+//! section inside `.cargo/config.toml`. Below is a table of tunable parameters
+//! for this crate:
+#![doc = ""]
+#![doc = include_str!(concat!(env!("OUT_DIR"), "/esp_ieee802154_config_table.md"))]
 #![doc(html_logo_url = "https://avatars.githubusercontent.com/u/46717278")]
 #![no_std]