Merge #553

553: Fixes in multi line description generation r=burrbull a=luojia65

This pull request contains two fixes:
1. New line separators are now rendered in enumerated values. 
2. Multi line field descriptions are now rendered correctly in write and read registers.

This issue happened because the original code accidentally unescaped and respaced twice in field parse proccess. It uses escaped description [L292](https://github.com/rust-embedded/svd2rust/compare/master...luojia65:fix-new-line?expand=1#diff-ff493acd6701940416e9725ce824c71d3039b5c56efc3721cf15d1688b3f7deaL292) as input, but in `desctiption_with_bits` function later [L1001](https://github.com/rust-embedded/svd2rust/compare/master...luojia65:fix-new-line?expand=1#diff-ff493acd6701940416e9725ce824c71d3039b5c56efc3721cf15d1688b3f7deaL1001 ) it unescaped again, resulting in loss of new line separators `\n`.

Before:

![图片](https://user-images.githubusercontent.com/40385009/141669374-2d6246c6-d6a0-4e9f-b107-5fc2b53c1498.png)

After:

![图片](https://user-images.githubusercontent.com/40385009/141669385-8850d267-7879-4600-a5d1-d29cb0d6ab20.png)

Co-authored-by: luojia65 <me@luojia.cc>

Author: bors[bot]

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 - Bug with `use_mask`
 - Correct derive for register (cluster) array (needs `svd-rs` 0.11.2) 
+- New line separators are now rendered in enumerated values
+- Multi line field descriptions are now rendered correctly in write and read registers
 
 ### Added
 

src/generate/register.rs

@@ -289,11 +289,8 @@ pub fn fields(
         let name_sc = Ident::new(&name.to_sanitized_snake_case(), span);
         let name_pc = name.to_sanitized_upper_case();
         let bits = Ident::new(if width == 1 { "bit" } else { "bits" }, span);
-        let description = if let Some(d) = &f.description {
-            util::respace(&util::escape_brackets(d))
-        } else {
-            "".to_owned()
-        };
+        let description_raw = f.description.as_ref().map(|s| s.as_str()).unwrap_or(""); // raw description, if absent using empty string
+        let description = util::respace(&util::escape_brackets(description_raw));
 
         let can_read = can_read
             && (f.access != Some(Access::WriteOnly))
@@ -427,7 +424,7 @@ pub fn fields(
                         Span::call_site(),
                     );
                     let doc = util::replace_suffix(
-                        &description_with_bits(&description, sub_offset, width),
+                        &description_with_bits(&description_raw, sub_offset, width),
                         suffix,
                     );
                     r_impl_items.extend(quote! {
@@ -439,7 +436,7 @@ pub fn fields(
                     });
                 }
             } else {
-                let doc = description_with_bits(&description, offset, width);
+                let doc = description_with_bits(&description_raw, offset, width);
                 r_impl_items.extend(quote! {
                     #[doc = #doc]
                     #inline
@@ -792,7 +789,7 @@ pub fn fields(
                         Span::call_site(),
                     );
                     let doc = util::replace_suffix(
-                        &description_with_bits(&description, sub_offset, width),
+                        &description_with_bits(&description_raw, sub_offset, width),
                         suffix,
                     );
                     let sub_offset = util::unsuffixed(sub_offset as u64);
@@ -815,7 +812,7 @@ pub fn fields(
                     }
                 }
             } else {
-                let doc = description_with_bits(&description, offset, width);
+                let doc = description_with_bits(&description_raw, offset, width);
                 w_impl_items.extend(quote! {
                     #[doc = #doc]
                     #inline
@@ -935,7 +932,7 @@ fn add_from_variants(
 
     let mut vars = TokenStream::new();
     for v in variants.iter().map(|v| {
-        let desc = util::escape_brackets(&format!("{}: {}", v.value, v.doc));
+        let desc = util::escape_brackets(&util::respace(&format!("{}: {}", v.value, v.doc)));
         let pcv = &v.pc;
         let pcval = &util::unsuffixed(v.value);
         quote! {