From e15d3750ea05f3adca01d1f54b9ec39ce304b983 Mon Sep 17 00:00:00 2001
From: Daniel Franklin <daniel@danielzfranklin.org>
Date: Fri, 11 Feb 2022 13:00:45 -0800
Subject: Document #[embassy::main(config = ...)]

Add an example documenting the config param based on help I got in the matrix chat.

Because the example is very short and incompatible with the other example code I just included it inline.
---
 docs/modules/ROOT/pages/basic_application.adoc | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'docs/modules/ROOT/pages/basic_application.adoc')

diff --git a/docs/modules/ROOT/pages/basic_application.adoc b/docs/modules/ROOT/pages/basic_application.adoc
index 749869ec0..11362b070 100644
--- a/docs/modules/ROOT/pages/basic_application.adoc
+++ b/docs/modules/ROOT/pages/basic_application.adoc
@@ -48,6 +48,18 @@ The `Spawner` is the way the main application spawns other tasks. The `Periphera
 include::example$basic/src/main.rs[lines="28..-1"]
 ----
 
+`#[embassy::main]` takes an optional `config` paramter specifying a function that returns an instance of HAL's `Config` struct. For example:
+
+```rust
+fn embassy_config() -> embassy_nrf::config::Config {
+    embassy_nrf::config::Config::default()
+}
+
+#[embassy::main(config = "embassy_config()")]
+async fn main(_spawner: embassy::executor::Spawner, p: embassy_nrf::Peripherals) {
+    // ...
+}
+```
 
 What happens when the `blinker` task have been spawned and main returns? Well, the main entry point is actually just like any other task, except that you can only have one and it takes some specific type arguments. The magic lies within the `#[embassy::main]` macro. The macro does the following:
 
-- 
cgit 

