From 50f26e78eda57cb1f9f815aa93b357c2cd1a0205 Mon Sep 17 00:00:00 2001
From: Emil Fresk <emil.fresk@gmail.com>
Date: Thu, 22 Apr 2021 18:38:42 +0200
Subject: [PATCH] Keep comments

---
 macros/src/codegen/dispatchers.rs    | 2 ++
 macros/src/codegen/module.rs         | 1 +
 macros/src/codegen/post_init.rs      | 1 +
 macros/src/codegen/resources.rs      | 4 +++-
 macros/src/codegen/software_tasks.rs | 1 +
 macros/src/codegen/timer_queue.rs    | 4 ++++
 6 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/macros/src/codegen/dispatchers.rs b/macros/src/codegen/dispatchers.rs
index 6aca901aea..382e33fe40 100644
--- a/macros/src/codegen/dispatchers.rs
+++ b/macros/src/codegen/dispatchers.rs
@@ -26,6 +26,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
             })
             .collect::<Vec<_>>();
 
+        // For future use
         // let doc = format!(
         //     "Software tasks to be dispatched at priority level {}",
         //     level,
@@ -53,6 +54,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
             )
         };
 
+        // For future use
         // let doc = format!(
         //     "Queue of tasks ready to be dispatched at priority level {}",
         //     level
diff --git a/macros/src/codegen/module.rs b/macros/src/codegen/module.rs
index 8c148ccb14..9bcc8f640d 100644
--- a/macros/src/codegen/module.rs
+++ b/macros/src/codegen/module.rs
@@ -305,6 +305,7 @@ pub fn codegen(
             let user_imports = &app.user_imports;
             let tq_marker = util::mark_internal_ident(&util::timer_queue_marker_ident());
 
+            // For future use
             // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
             // items.push(quote!(#[doc = #doc]));
 
diff --git a/macros/src/codegen/post_init.rs b/macros/src/codegen/post_init.rs
index 7dd1590338..78548bcdaf 100644
--- a/macros/src/codegen/post_init.rs
+++ b/macros/src/codegen/post_init.rs
@@ -31,6 +31,7 @@ pub fn codegen(app: &App, analysis: &Analysis) -> Vec<TokenStream2> {
     }
 
     for (i, (monotonic, _)) in app.monotonics.iter().enumerate() {
+        // For future use
         // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
         // stmts.push(quote!(#[doc = #doc]));
 
diff --git a/macros/src/codegen/resources.rs b/macros/src/codegen/resources.rs
index 5352369685..a623ea6037 100644
--- a/macros/src/codegen/resources.rs
+++ b/macros/src/codegen/resources.rs
@@ -31,7 +31,6 @@ pub fn codegen(
         let mangled_name = util::mark_internal_ident(&name);
 
         {
-            // TODO: do we really need this in the single core case
             // late resources in `util::link_section_uninit`
             let section = if expr.is_none() {
                 util::link_section_uninit(true)
@@ -56,6 +55,7 @@ pub fn codegen(
 
             let attrs = &res.attrs;
 
+            // For future use
             // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
             mod_app.push(quote!(
                 #[allow(non_upper_case_globals)]
@@ -69,6 +69,7 @@ pub fn codegen(
         }
 
         let r_prop = &res.properties;
+        // For future use
         // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
 
         if !r_prop.task_local && !r_prop.lock_free {
@@ -122,6 +123,7 @@ pub fn codegen(
                 None => 0,
             };
 
+            // For future use
             // let doc = format!(" RTIC internal ({} resource): {}:{}", doc, file!(), line!());
 
             mod_app.push(util::impl_mutex(
diff --git a/macros/src/codegen/software_tasks.rs b/macros/src/codegen/software_tasks.rs
index e42fb88d41..0372e8ec83 100644
--- a/macros/src/codegen/software_tasks.rs
+++ b/macros/src/codegen/software_tasks.rs
@@ -65,6 +65,7 @@ pub fn codegen(
             let mono_type = &monotonic.ty;
 
             let uninit = mk_uninit();
+            // For future use
             // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
             mod_app.push(quote!(
                 #uninit
diff --git a/macros/src/codegen/timer_queue.rs b/macros/src/codegen/timer_queue.rs
index ed89af660e..14e9105453 100644
--- a/macros/src/codegen/timer_queue.rs
+++ b/macros/src/codegen/timer_queue.rs
@@ -35,6 +35,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
                 })
                 .collect::<Vec<_>>();
 
+            // For future use
             // let doc = "Tasks that can be scheduled".to_string();
             items.push(quote!(
                 // #[doc = #doc]
@@ -61,6 +62,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
 
         // Static variables and resource proxy
         {
+            // For future use
             // let doc = &format!("Timer queue for {}", monotonic_name);
             let cap = app
                 .software_tasks
@@ -71,6 +73,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
             let tq_ty =
                 quote!(core::mem::MaybeUninit<rtic::export::TimerQueue<#mono_type, #t, #n>>);
 
+            // For future use
             // let doc = format!(" RTIC internal: {}:{}", file!(), line!());
             items.push(quote!(
                 #[doc(hidden)]
@@ -80,6 +83,7 @@ pub fn codegen(app: &App, analysis: &Analysis, _extra: &Extra) -> Vec<TokenStrea
 
             let mono = util::monotonic_ident(&monotonic_name);
             let mono = util::mark_internal_ident(&mono);
+            // For future use
             // let doc = &format!("Storage for {}", monotonic_name);
 
             items.push(quote!(