This will be the v0.12 version

.cargo/config.toml

@@ -3,12 +3,12 @@ target = "thumbv4t-none-eabi"
 
 [unstable]
 build-std = ["core"]
-build-std-features = ["compiler-builtins-weak-intrinsics"]
 
 [target.thumbv4t-none-eabi]
 runner = "mgba-qt"
 rustflags = [
+  "-Zub-checks=no",
   "-Clinker=arm-none-eabi-ld",
   "-Clink-arg=-Tlinker_scripts/mono_boot.ld",
-  "--emit=mir",
+  "-Ctarget-cpu=arm7tdmi",
 ]

.github/workflows/ci-builds.yml

@@ -13,9 +13,6 @@ jobs:
           - { toolchain: nightly }
     steps:
       - uses: actions/checkout@v2
-
-      - name: Install Apt Dependencies
-        run: sudo apt-get update && sudo apt-get install binutils-arm-none-eabi
 
       - uses: actions-rs/toolchain@v1
         with:
@@ -25,10 +22,21 @@ jobs:
 
       - name: Install Rust Source
         run: rustup component add rust-src
+
+      - name: Install GNU Binutils
+        run: sudo apt-get update && sudo apt-get install binutils-arm-none-eabi
 
-      - name: Build The Examples
-        uses: actions-rs/cargo@v1
-        with:
-          toolchain: ${{ matrix.rust.toolchain }}
-          command: build
-          args: --examples
+      - name: Build The Examples (Link With GNU, weak compiler intrinsics)
+        run: cargo build --examples
+
+      - name: Check that all our features work
+        run: cargo build --examples --all-features
+
+      - name: Delete the .cargo/config.toml
+        run: rm -fr .cargo/config.toml
+
+      - name: Build The Examples (Link With LLD, strong compiler intrinsics)
+        run: RUSTFLAGS="-Clink-arg=-Tlinker_scripts/mono_boot.ld" cargo build --examples --target=thumbv4t-none-eabi -Zbuild-std=core
+
+      - name: Build The Crate For Host With No Default Features (build script usage simulation)
+        run: cargo build --no-default-features --lib

.vscode/settings.json

@@ -1,11 +1,7 @@
 {
-  "rust-analyzer.checkOnSave.allTargets": false,
-  "rust-analyzer.checkOnSave.overrideCommand": [
-    "cargo",
-    "build",
-    "--quiet",
-    "--workspace",
-    "--message-format=json",
+  "rust-analyzer.cargo.allTargets": false,
+  "rust-analyzer.check.command": "build",
+  "rust-analyzer.check.extraArgs": [
     "--lib",
     "--bins",
     "--examples"

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.12
+* A totally new version!
+
+## 0.11 and older
+
 * **0.11.6:**
   * `on_gba` feature (default: enabled) that signals if the crate is running on a GBA.
     Limited portions of the crate *can* be used even when not on the GBA (such as in a build script).

Cargo.toml

@@ -2,35 +2,49 @@
 name = "gba"
 description = "A crate for 'raw' style GBA development. If you want a 'managed' experience, try the `agb` crate instead."
 repository = "https://github.com/rust-console/gba"
-version = "0.11.6"
+version = "0.12.0"
 edition = "2021"
 license = "Zlib OR Apache-2.0 OR MIT"
 
 [features]
-default = ["track_caller", "on_gba"]
-track_caller = []
+default = ["on_gba"]
+# SEE THE CRATE DOCS FOR SAFETY RELATED INFO REGARDING THIS FEATURE.
 on_gba = []
+# utilize `doc_cfg` where appropriate. requires nightly. intended mostly for use
+# during docs.rs documentation generation.
+doc_cfg = []
+# Activates the `track_caller` attribute on various functions. Use of the
+# `track_caller` attribute on a function adds a "secret" extra argument for the
+# `Location` of the caller, which can reduce performance if the function is not
+# inlined (meaning  `Location` is passed via the stack). This is only needed for
+# debugging, and so it's off by default.
+track_caller = []
 
 [dependencies]
-voladdress = "1.3.0"
+voladdress = "1.4.0"
 bitfrob = "1"
-bracer = "0.1.2"
 critical-section = { version = "1.1.2", features = [
   "restore-state-bool",
 ], optional = true }
+bytemuck = { version = "1.16.0", optional = true }
+fixed = { version = "1.27.0", default-features = false, optional = true }
+bracer = "0.3.1"
 
 [profile.dev]
 opt-level = 3
 incremental = false
 
 [profile.dev.package."*"]
+# this prevents `core` from having way too many debug assertions
 debug-assertions = false
 
 [profile.release]
-codegen-units = 1
+codegen-units = 1   # increases build time, but also can increase inline opportunities
 incremental = false
 
 [package.metadata.docs.rs]
-# The crate can only be built for targets that have thumb-interworking support,
-# because otherwise the instruction_set attribute can't be used.
+# When building the crate docs, we want to see the crate "as if" it was running
+# on the GBA. This is the closest target that docs.rs supports by default and
+# which *also* supports the `instruction_set` attribute to avoid build errors.
 targets = ["armv5te-unknown-linux-gnueabi"]
+features = ["doc_cfg"]

README.md

@@ -4,13 +4,21 @@
 
 This crate is intended for working with the GBA.
 
-To build for the GBA you'll need to use `build-std` and you'll also need to
-activate the `compiler-builtins-weak-intrinsics` feature.
+To build for the GBA you'll need to use `build-std` (on Nightly) with the
+`thumbv4t-none-eabi` or `armv4t-none-eabi` targets. The two targets are
+identical except for which instruction set (thumb or arm) is used by default. It
+is suggested that you use the thumb target, unless you know what you're doing and
+have a very good reason to use the arm target.
 
-The following should be somewhere in your `.cargo/config.toml`:
+Your `.cargo/config.toml` should look something like this:
 
 ```toml
+[build]
+target = "thumbv4t-none-eabi"
+
 [unstable]
 build-std = ["core"]
-build-std-features = ["compiler-builtins-weak-intrinsics"]
 ```
+
+If you don't use this crate on the GBA, you **MUST** disable default features and
+then not use the `on_gba` cargo feature.