From 1dc2f80eb6cb6ac6d1eaede4169d8cabc51c5e7c Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 17:37:15 +0200 Subject: Begin migration guide --- book/en/src/SUMMARY.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 587117c..ceed24e 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -24,6 +24,7 @@ - [RTIC vs. the world](./rtic_vs.md) - [Awesome RTIC examples](./awesome_rtic.md) @@ -43,4 +44,13 @@ - [Message passing & `capacity`](./by-example/message_passing.md) - [Task priorities](./by-example/app_priorities.md) - [Monotonic & `spawn_{at/after}`](./by-example/monotonic.md) - --> \ No newline at end of file + --> + +--- + +- [Migrating from v1.0.x to v2.0.0](./migration/migration_v2.md) + - [Rust Nightly & features](./migration/migration_v2/nightly.md) + - [Migrating to `rtic-monotonics`](./migration/migration_v2/monotonics.md) + - [Software tasks must now be `async`](./migration/migration_v2/async_tasks.md) + - [Using and understanding `rtic-sync`](./migration/migration_v2/rtic-sync.md) + - [A code example on migration](./migration/migration_v2/complete_example.md) \ No newline at end of file -- cgit v1.2.3 From 3d97c9e431d7fcb20b1b30bc15c34ccffee03c79 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 21:27:26 +0200 Subject: Move deprecated migration guides to deprecated folder --- book/en/src/SUMMARY.md | 22 +++++++--------------- 1 file changed, 7 insertions(+), 15 deletions(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index ceed24e..8b19bf1 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -23,11 +23,12 @@ - [RTIC vs. the world](./rtic_vs.md) - [Awesome RTIC examples](./awesome_rtic.md) - +- [Migrating from v1.0.x to v2.0.0](./migration_v1_v2.md) + - [Rust Nightly & features](./migration_v1_v2/nightly.md) + - [Migrating to `rtic-monotonics`](./migration_v1_v2/monotonics.md) + - [Software tasks must now be `async`](./migration_v1_v2/async_tasks.md) + - [Using and understanding `rtic-sync`](./migration_v1_v2/rtic-sync.md) + - [A code example on migration](./migration_v1_v2/complete_example.md) - [Under the hood](./internals.md) - [Cortex-M architectures](./internals/targets.md) @@ -44,13 +45,4 @@ - [Message passing & `capacity`](./by-example/message_passing.md) - [Task priorities](./by-example/app_priorities.md) - [Monotonic & `spawn_{at/after}`](./by-example/monotonic.md) - --> - ---- - -- [Migrating from v1.0.x to v2.0.0](./migration/migration_v2.md) - - [Rust Nightly & features](./migration/migration_v2/nightly.md) - - [Migrating to `rtic-monotonics`](./migration/migration_v2/monotonics.md) - - [Software tasks must now be `async`](./migration/migration_v2/async_tasks.md) - - [Using and understanding `rtic-sync`](./migration/migration_v2/rtic-sync.md) - - [A code example on migration](./migration/migration_v2/complete_example.md) \ No newline at end of file + --> \ No newline at end of file -- cgit v1.2.3 From 552ecd4458e24369932bc4a3dd641c4c4e3e59fc Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 22:53:45 +0200 Subject: Promote starting a new project to it's own chapter --- book/en/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 8b19bf1..a500fd9 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -2,6 +2,7 @@ [Preface](./preface.md) +- [Starting a new project](./starting_a_project.md) - [RTIC by example](./by-example.md) - [The `app`](./by-example/app.md) - [Hardware tasks & `pend`](./by-example/hardware_tasks.md) @@ -11,7 +12,6 @@ - [The idle task](./by-example/app_idle.md) - [Channel based communication](./by-example/channel.md) - [Delay and Timeout](./by-example/delay.md) - - [Starting a new project](./by-example/starting_a_project.md) - [The minimal app](./by-example/app_minimal.md) - [Tips & Tricks](./by-example/tips.md) - [Implementing Monotonic](./by-example/tips_monotonic_impl.md) -- cgit v1.2.3 From 6c2c1ab25197ab4a202cda3620370714aebc663a Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 22 Apr 2023 22:57:24 +0200 Subject: Clarify delay and timeout uses monotonics --- book/en/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index a500fd9..3e2b9ca 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -11,7 +11,7 @@ - [The init task](./by-example/app_init.md) - [The idle task](./by-example/app_idle.md) - [Channel based communication](./by-example/channel.md) - - [Delay and Timeout](./by-example/delay.md) + - [Delay and Timeout using Monotonics](./by-example/delay.md) - [The minimal app](./by-example/app_minimal.md) - [Tips & Tricks](./by-example/tips.md) - [Implementing Monotonic](./by-example/tips_monotonic_impl.md) -- cgit v1.2.3 From e51146a98cc7c83ea574d13b4b5d8e7ceeeb004b Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sun, 23 Apr 2023 13:22:35 +0200 Subject: Move tips into their own subdir --- book/en/src/SUMMARY.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 3e2b9ca..ff9cffe 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -13,13 +13,13 @@ - [Channel based communication](./by-example/channel.md) - [Delay and Timeout using Monotonics](./by-example/delay.md) - [The minimal app](./by-example/app_minimal.md) - - [Tips & Tricks](./by-example/tips.md) - - [Implementing Monotonic](./by-example/tips_monotonic_impl.md) - - [Resource de-structure-ing](./by-example/tips_destructureing.md) - - [Avoid copies when message passing](./by-example/tips_indirection.md) - - [`'static` super-powers](./by-example/tips_static_lifetimes.md) - - [Inspecting generated code](./by-example/tips_view_code.md) - + - [Tips & Tricks](./by-example/tips/index.md) + - [Implementing Monotonic](./by-example/tips/monotonic_impl.md) + - [Resource de-structure-ing](./by-example/tips/destructureing.md) + - [Avoid copies when message passing](./by-example/tips/indirection.md) + - [`'static` super-powers](./by-example/tips/static_lifetimes.md) + - [Inspecting generated code](./by-example/tips/view_code.md) + - [RTIC vs. the world](./rtic_vs.md) - [Awesome RTIC examples](./awesome_rtic.md) -- cgit v1.2.3 From e3603d1d0531a4593c4c75863fc77162813cf34f Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Fri, 5 May 2023 18:58:06 +0200 Subject: Rename deprecated to archive --- book/en/src/SUMMARY.md | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index ff9cffe..4a852f7 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -2,6 +2,8 @@ [Preface](./preface.md) +--- + - [Starting a new project](./starting_a_project.md) - [RTIC by example](./by-example.md) - [The `app`](./by-example/app.md) @@ -23,12 +25,18 @@ - [RTIC vs. the world](./rtic_vs.md) - [Awesome RTIC examples](./awesome_rtic.md) + +--- + - [Migrating from v1.0.x to v2.0.0](./migration_v1_v2.md) - [Rust Nightly & features](./migration_v1_v2/nightly.md) - [Migrating to `rtic-monotonics`](./migration_v1_v2/monotonics.md) - [Software tasks must now be `async`](./migration_v1_v2/async_tasks.md) - [Using and understanding `rtic-sync`](./migration_v1_v2/rtic-sync.md) - [A code example on migration](./migration_v1_v2/complete_example.md) + +--- + - [Under the hood](./internals.md) - [Cortex-M architectures](./internals/targets.md) -- cgit v1.2.3 From 5c6483f71b1622e518847006147f2360c7563aa6 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Fri, 5 May 2023 19:21:02 +0200 Subject: Update these --- book/en/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index 4a852f7..baeb036 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -7,7 +7,7 @@ - [Starting a new project](./starting_a_project.md) - [RTIC by example](./by-example.md) - [The `app`](./by-example/app.md) - - [Hardware tasks & `pend`](./by-example/hardware_tasks.md) + - [Hardware tasks](./by-example/hardware_tasks.md) - [Software tasks & `spawn`](./by-example/software_tasks.md) - [Resources](./by-example/resources.md) - [The init task](./by-example/app_init.md) -- cgit v1.2.3 From 4b3bf59215d682e9473ca66545a1f7c2acbccbfe Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 20 May 2023 11:24:03 +0200 Subject: Move some more stuff to the archive, update this link --- book/en/src/SUMMARY.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index baeb036..e8c8ee6 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -21,8 +21,6 @@ - [Avoid copies when message passing](./by-example/tips/indirection.md) - [`'static` super-powers](./by-example/tips/static_lifetimes.md) - [Inspecting generated code](./by-example/tips/view_code.md) - - - [RTIC vs. the world](./rtic_vs.md) - [Awesome RTIC examples](./awesome_rtic.md) -- cgit v1.2.3 From 039c2b8bd440018531d79785c63bbfb74f0e686c Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 20 May 2023 11:45:23 +0200 Subject: Add some docs on RTIC AND embassy --- book/en/src/SUMMARY.md | 1 + 1 file changed, 1 insertion(+) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index e8c8ee6..c5e69e5 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -22,6 +22,7 @@ - [`'static` super-powers](./by-example/tips/static_lifetimes.md) - [Inspecting generated code](./by-example/tips/view_code.md) - [RTIC vs. the world](./rtic_vs.md) +- [RTIC and Embassy](./rtic_and_embassy.md) - [Awesome RTIC examples](./awesome_rtic.md) --- -- cgit v1.2.3 From 311291b95adbd24ecd037f5e555e4c30138f4339 Mon Sep 17 00:00:00 2001 From: datdenkikniet Date: Sat, 20 May 2023 12:02:51 +0200 Subject: Make Monotonic implementation more obvious --- book/en/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'book/en/src/SUMMARY.md') diff --git a/book/en/src/SUMMARY.md b/book/en/src/SUMMARY.md index c5e69e5..4083284 100644 --- a/book/en/src/SUMMARY.md +++ b/book/en/src/SUMMARY.md @@ -16,11 +16,11 @@ - [Delay and Timeout using Monotonics](./by-example/delay.md) - [The minimal app](./by-example/app_minimal.md) - [Tips & Tricks](./by-example/tips/index.md) - - [Implementing Monotonic](./by-example/tips/monotonic_impl.md) - [Resource de-structure-ing](./by-example/tips/destructureing.md) - [Avoid copies when message passing](./by-example/tips/indirection.md) - [`'static` super-powers](./by-example/tips/static_lifetimes.md) - [Inspecting generated code](./by-example/tips/view_code.md) +- [Monotonics & the Timer Queue](./monotonic_impl.md) - [RTIC vs. the world](./rtic_vs.md) - [RTIC and Embassy](./rtic_and_embassy.md) - [Awesome RTIC examples](./awesome_rtic.md) -- cgit v1.2.3