Add include-compatible config flag

When developing FPGA, code needs to be generated dynamically.
Idiomatic way of doing it is using `include!` macro:
https://doc.rust-lang.org/cargo/reference/build-script-examples.html#code-generation
But top-level attributes can't be used with it:
rust-lang/rfcs#752
So I added a config flag that disables generation of all top-level attributes.

Author: Shatur

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [v0.31.2] - 2023-11-29
 
+- Add `include-compatible` config flag
 - Add iterators for register/cluster/field arrays
 - Use parentheses instead of square brackets in docs for field arrays
 

src/config.rs

@@ -10,6 +10,7 @@ pub struct Config {
     pub atomics_feature: Option<String>,
     pub generic_mod: bool,
     pub make_mod: bool,
+    pub include_compatible: bool,
     pub ignore_groups: bool,
     pub keep_list: bool,
     pub strict: bool,

src/generate/device.rs

@@ -29,28 +29,31 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
         }
     };
 
-    let doc = format!(
-        "Peripheral access API for {0} microcontrollers \
-         (generated using svd2rust v{1}{commit_info})\n\n\
-         You can find an overview of the generated API [here].\n\n\
-         API features to be included in the [next] svd2rust \
-         release can be generated by cloning the svd2rust [repository], \
-         checking out the above commit, and running `cargo doc --open`.\n\n\
-         [here]: https://docs.rs/svd2rust/{1}/svd2rust/#peripheral-api\n\
-         [next]: https://github.com/rust-embedded/svd2rust/blob/master/CHANGELOG.md#unreleased\n\
-         [repository]: https://github.com/rust-embedded/svd2rust",
-        d.name.to_uppercase(),
-        env!("CARGO_PKG_VERSION"),
-    );
-
     if config.target == Target::Msp430 {
         out.extend(quote! {
             #![feature(abi_msp430_interrupt)]
         });
     }
 
-    out.extend(quote! { #![doc = #doc] });
-    if !config.make_mod {
+    if !config.include_compatible {
+        let doc = format!(
+            "Peripheral access API for {0} microcontrollers \
+             (generated using svd2rust v{1}{commit_info})\n\n\
+             You can find an overview of the generated API [here].\n\n\
+             API features to be included in the [next] svd2rust \
+             release can be generated by cloning the svd2rust [repository], \
+             checking out the above commit, and running `cargo doc --open`.\n\n\
+             [here]: https://docs.rs/svd2rust/{1}/svd2rust/#peripheral-api\n\
+             [next]: https://github.com/rust-embedded/svd2rust/blob/master/CHANGELOG.md#unreleased\n\
+             [repository]: https://github.com/rust-embedded/svd2rust",
+            d.name.to_uppercase(),
+            env!("CARGO_PKG_VERSION"),
+        );
+
+        out.extend(quote! { #![doc = #doc] });
+    }
+
+    if !config.make_mod && !config.include_compatible {
         out.extend(quote! {
             // Explicitly allow a few warnings that may be verbose
             #![allow(non_camel_case_types)]

src/main.rs

@@ -157,6 +157,13 @@ fn run() -> Result<()> {
                 .action(ArgAction::SetTrue)
                 .help("Create mod.rs instead of lib.rs, without inner attributes"),
         )
+        .arg(
+            Arg::new("include_compatible")
+                .long("include-compatible")
+                .alias("include_compatible")
+                .action(ArgAction::SetTrue)
+                .help("Do not generate top-level attributes to make it compatible with include! macro"),
+        )
         .arg(
             Arg::new("strict")
                 .long("strict")