diff --git a/book/src/01-limitations/00-index.md b/book/src/01-limitations/00-index.md deleted file mode 100644 index 3cfc7fc..0000000 --- a/book/src/01-limitations/00-index.md +++ /dev/null @@ -1,10 +0,0 @@ -# GBA Limitations - -There's a lot of seemingly normal Rust code that you can't write when compiling -for the GBA. - -I mean there's a lot of stuff that you _can_ write, but we don't wanna get -tripped up by assuming we can use something only to get stuck when it's missing. - -We'll start the book by reviewing all the major things we don't have so that we -can avoid any surprises later. diff --git a/book/src/01-quirks/00-index.md b/book/src/01-quirks/00-index.md new file mode 100644 index 0000000..8df76e7 --- /dev/null +++ b/book/src/01-quirks/00-index.md @@ -0,0 +1,9 @@ +# Quirks + +The GBA supports a lot of totally normal Rust code exactly like you'd think. + +However, it also is missing a lot of what you might expect, and sometimes we +have to do things in slightly weird ways. + +We start the book by covering the quirks our code will have, just to avoid too +many surprises later. diff --git a/book/src/01-limitations/01-no_std.md b/book/src/01-quirks/01-no_std.md similarity index 98% rename from book/src/01-limitations/01-no_std.md rename to book/src/01-quirks/01-no_std.md index 4eb9a74..13faa72 100644 --- a/book/src/01-limitations/01-no_std.md +++ b/book/src/01-quirks/01-no_std.md @@ -89,6 +89,10 @@ the standard library types to be used "for free" once it was set up, or just a custom allocator that's GBA specific if Rust's global allocator style isn't a good fit for the GBA (I honestly haven't looked into it). +## LLVM Intrinsics + +TODO: explain that we'll occasionally have to provide some intrinsics. + ## Bare Metal Panic TODO: expand this diff --git a/book/src/01-limitations/02-fixed_only.md b/book/src/01-quirks/02-fixed_only.md similarity index 100% rename from book/src/01-limitations/02-fixed_only.md rename to book/src/01-quirks/02-fixed_only.md diff --git a/book/src/01-limitations/03-volatile_destination.md b/book/src/01-quirks/03-volatile_destination.md similarity index 100% rename from book/src/01-limitations/03-volatile_destination.md rename to book/src/01-quirks/03-volatile_destination.md diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index c9aca10..4fc9ca4 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -8,10 +8,10 @@ * [Hello, Magic](00-introduction/04-hello-magic.md) * [Newtype](00-introduction/05-newtype.md) * [Help and Resources](00-introduction/06-help_and_resources.md) -* [Limitations](01-limitations/00-index.md) - * [No Std](01-limitations/01-no_std.md) - * [Fixed Only](01-limitations/02-fixed_only.md) - * [Volatile Destination](01-limitations/03-volatile_destination.md) +* [Quirks](01-quirks/00-index.md) + * [No Std](01-quirks/01-no_std.md) + * [Fixed Only](01-quirks/02-fixed_only.md) + * [Volatile Destination](01-quirks/03-volatile_destination.md) * [Concepts](02-concepts/00-index.md) * [CPU](02-concepts/01-cpu.md) * [BIOS](02-concepts/02-bios.md)