Change nightly flag to atomics

Author: YuhanLiin

.github/workflows/ci.yml

@@ -53,36 +53,36 @@ jobs:
           - { rust: stable, vendor: Freescale, options: all }
           - { rust: stable, vendor: Freescale, options: "" }
           - { rust: stable, vendor: Fujitsu, options: "" }
-          - { rust: stable, vendor: Fujitsu, options: "--nightly" }
+          - { rust: stable, vendor: Fujitsu, options: "--atomics" }
           - { rust: stable, vendor: GD32, options: all }
           - { rust: stable, vendor: GD32, options: "" }
           - { rust: stable, vendor: Holtek, options: all }
           - { rust: stable, vendor: Holtek, options: "" }
           - { rust: stable, vendor: Microchip, options: "" }
-          - { rust: stable, vendor: Microchip, options: "--nightly" }
+          - { rust: stable, vendor: Microchip, options: "--atomics" }
           - { rust: stable, vendor: Nordic, options: all }
           - { rust: stable, vendor: Nordic, options: "" }
           - { rust: stable, vendor: Nuvoton, options: "" }
-          - { rust: stable, vendor: Nuvoton, options: "--nightly" }
+          - { rust: stable, vendor: Nuvoton, options: "--atomics" }
           - { rust: stable, vendor: NXP, options: all }
           - { rust: stable, vendor: NXP, options: "" }
           - { rust: stable, vendor: RISC-V, options: "" }
-          - { rust: stable, vendor: RISC-V, options: "--nightly" }
+          - { rust: stable, vendor: RISC-V, options: "--atomics" }
           - { rust: stable, vendor: SiliconLabs, options: all }
           - { rust: stable, vendor: SiliconLabs, options: "" }
           - { rust: stable, vendor: Spansion, options: "" }
-          - { rust: stable, vendor: Spansion, options: "--nightly" }
+          - { rust: stable, vendor: Spansion, options: "--atomics" }
           - { rust: stable, vendor: STMicro, options: "" }
-          - { rust: stable, vendor: STMicro, options: "--nightly" }
-          - { rust: stable, vendor: STM32-patched, options: "--strict --const_generic --derive_more --pascal_enum_values --max_cluster_size --nightly" }
+          - { rust: stable, vendor: STMicro, options: "--atomics" }
+          - { rust: stable, vendor: STM32-patched, options: "--strict --const_generic --derive_more --pascal_enum_values --max_cluster_size --atomics" }
           - { rust: stable, vendor: Toshiba, options: all }
           - { rust: stable, vendor: Toshiba, options: "" }
           # Test MSRV
           - { rust: 1.60.0, vendor: Nordic, options: "" }
           # Use nightly for architectures which don't support stable
-          - { rust: nightly, vendor: MSP430, options: "--nightly" }
+          - { rust: nightly, vendor: MSP430, options: "--atomics" }
           - { rust: nightly, vendor: MSP430, options: "" }
-          - { rust: nightly, vendor: Espressif, options: "--nightly" }
+          - { rust: nightly, vendor: Espressif, options: "--atomics" }
           - { rust: nightly, vendor: Espressif, options: "" }
 
     steps:

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - simplify ci strategy
 - Fix generated code for MSP430 atomics
 - Generate atomic register code for non-MSP430 targets
+- Change --nightly flag to --atomics
 
 ## [v0.27.1] - 2022-10-25
 

ci/script.sh

@@ -31,7 +31,7 @@ main() {
 
     case $OPTIONS in
         all)
-            options="--const_generic --strict --derive_more --nightly"
+            options="--const_generic --strict --derive_more --atomics"
             ;;
         *)
             options=$OPTIONS
@@ -46,7 +46,7 @@ main() {
     if [[ "$options" == *"--derive_more"* ]]; then
         echo 'derive_more = "0.99"' >> $td/Cargo.toml
     fi
-    if [[ "$options" == *"--nightly"* ]]; then
+    if [[ "$options" == *"--atomics"* ]]; then
         echo 'portable-atomic = { version = "0.3.15", default-features = false }' >> $td/Cargo.toml
     fi
     echo '[profile.dev]' >> $td/Cargo.toml

ci/svd2rust-regress/src/main.rs

@@ -29,9 +29,9 @@ struct Opt {
     bin_path: Option<PathBuf>,
 
     // TODO: Consider using the same strategy cargo uses for passing args to rustc via `--`
-    /// Run svd2rust with `--nightly`
-    #[structopt(long = "nightly")]
-    nightly: bool,
+    /// Run svd2rust with `--atomics`
+    #[structopt(long = "atomics")]
+    atomics: bool,
 
     /// Filter by chip name, case sensitive, may be combined with other filters
     #[structopt(short = "c", long = "chip", raw(validator = "validate_chips"))]
@@ -240,7 +240,7 @@ fn main() {
     tests.par_iter().for_each(|t| {
         let start = Instant::now();
 
-        match svd_test::test(t, &bin_path, rustfmt_bin_path, opt.nightly, opt.verbose) {
+        match svd_test::test(t, &bin_path, rustfmt_bin_path, opt.atomics, opt.verbose) {
             Ok(s) => {
                 if let Some(stderrs) = s {
                     let mut buf = String::new();

ci/svd2rust-regress/src/svd_test.rs

@@ -7,7 +7,7 @@ use std::process::{Command, Output};
 
 const CRATES_ALL: &[&str] = &["critical-section = \"1.0\"", "vcell = \"0.1.2\""];
 const CRATES_MSP430: &[&str] = &["msp430 = \"0.4.0\"", "msp430-rt = \"0.4.0\""];
-const CRATES_NIGHTLY: &[&str] =
+const CRATES_ATOMICS: &[&str] =
     &["portable-atomic = { version = \"0.3.15\", default-features = false }"];
 const CRATES_CORTEX_M: &[&str] = &["cortex-m = \"0.7.6\"", "cortex-m-rt = \"0.6.13\""];
 const CRATES_RISCV: &[&str] = &["riscv = \"0.9.0\"", "riscv-rt = \"0.9.0\""];
@@ -85,7 +85,7 @@ pub fn test(
     t: &TestCase,
     bin_path: &PathBuf,
     rustfmt_bin_path: Option<&PathBuf>,
-    nightly: bool,
+    atomics: bool,
     verbosity: u8,
 ) -> Result<Option<Vec<PathBuf>>> {
     let user = match std::env::var("USER") {
@@ -137,8 +137,8 @@ pub fn test(
             Msp430 => CRATES_MSP430.iter(),
             XtensaLX => CRATES_XTENSALX.iter(),
         })
-        .chain(if nightly {
-            CRATES_NIGHTLY.iter()
+        .chain(if atomics {
+            CRATES_ATOMICS.iter()
         } else {
             [].iter()
         })
@@ -177,8 +177,8 @@ pub fn test(
         XtensaLX => "xtensa-lx",
     };
     let mut svd2rust_bin = Command::new(bin_path);
-    if nightly {
-        svd2rust_bin.arg("--nightly");
+    if atomics {
+        svd2rust_bin.arg("--atomics");
     }
 
     let output = svd2rust_bin

src/generate/device.rs

@@ -152,7 +152,7 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
     if config.generic_mod {
         let mut file = File::create(config.output_dir.join("generic.rs"))?;
         writeln!(file, "{}", generic_file)?;
-        if config.nightly {
+        if config.atomics {
             writeln!(file, "\n{}", generic_atomic_file)?;
         }
         if config.const_generic {
@@ -169,7 +169,7 @@ pub fn render(d: &Device, config: &Config, device_x: &mut String) -> Result<Toke
         }
     } else {
         let mut tokens = syn::parse_file(generic_file)?.into_token_stream();
-        if config.nightly {
+        if config.atomics {
             syn::parse_file(generic_atomic_file)?.to_tokens(&mut tokens);
         }
         if config.const_generic {

src/lib.rs

@@ -484,17 +484,12 @@
 //!
 //! [`interrupt`]: https://docs.rs/cortex-m-rt-macros/0.1/cortex_m_rt_macros/attr.interrupt.html
 //!
-//! ## the `--nightly` flag
+//! ## the `--atomics` flag
 //!
-//! The `--nightly` flag can be passed to `svd2rust` to enable features in the generated api that are only available to a nightly
-//! compiler. The following features are gated by the `--nightly` flag:
-//!
-//! ### Atomics
-//!
-//! Extends the register API with operations to atomically set, clear, and toggle specific bits.
-//! The atomic operations allow limited modification of register bits without read-modify-write
-//! sequences. As such, they can be concurrently called on different bits in the same register
-//! without data races.
+//! The `--atomics` flag can be passed to `svd2rust` to extends the register API with operations to
+//! atomically set, clear, and toggle specific bits.  The atomic operations allow limited
+//! modification of register bits without read-modify-write sequences. As such, they can be
+//! concurrently called on different bits in the same register without data races.
 //!
 //! `portable-atomic` v0.3.15 must be added to the dependencies, with default features off if
 //! possible to disable the `fallback` feature.

src/main.rs

@@ -67,10 +67,10 @@ fn run() -> Result<()> {
                 .value_name("ARCH"),
         )
         .arg(
-            Arg::new("nightly")
-                .long("nightly")
+            Arg::new("atomics")
+                .long("atomics")
                 .action(ArgAction::SetTrue)
-                .help("Enable features only available to nightly rustc"),
+                .help("Generate atomic register modification API"),
         )
         .arg(
             Arg::new("const_generic")

src/util.rs

@@ -27,7 +27,7 @@ pub struct Config {
     #[cfg_attr(feature = "serde", serde(default))]
     pub target: Target,
     #[cfg_attr(feature = "serde", serde(default))]
-    pub nightly: bool,
+    pub atomics: bool,
     #[cfg_attr(feature = "serde", serde(default))]
     pub generic_mod: bool,
     #[cfg_attr(feature = "serde", serde(default))]
@@ -68,7 +68,7 @@ impl Default for Config {
     fn default() -> Self {
         Self {
             target: Target::default(),
-            nightly: false,
+            atomics: false,
             generic_mod: false,
             make_mod: false,
             const_generic: false,