From 5de7903c9d560038a0eaf9c43431474c55d415af Mon Sep 17 00:00:00 2001
From: Dan Gohman <dev@sunfishcode.online>
Date: Fri, 11 Oct 2024 08:06:43 -0700
Subject: [PATCH] Misc code cleanups. (#151)

Add comments to c-scape's nightly features, sort the main `mod` list in
lib.rs, and remove obsolete references to `compiler_builtins`.
---
 README.md          |  4 +--
 c-scape/src/lib.rs | 71 +++++++++++++++++++++-------------------------
 2 files changed, 33 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 04d53b1..9037b3f 100644
--- a/README.md
+++ b/README.md
@@ -56,9 +56,7 @@ However, `#[no_builtins]` is too pessimistic, because we don't need to disable
 all pattern matching, just these specific cases.
 
 So instead, c-scape and c-gull are just careful to avoid open-coding functions
-which are known to get pattern-matched into builtins, by just calling the
-`compiler_builtins` implementations directly themselves. This way, we can avoid
-using `#![no_builtins]`.
+which are known to get pattern-matched into builtins.
 
 [c-scape]: https://github.com/sunfishcode/c-ward/tree/main/c-scape#readme
 [c-gull]: https://github.com/sunfishcode/c-ward/tree/main/c-gull#readme
diff --git a/c-scape/src/lib.rs b/c-scape/src/lib.rs
index 286d450..0c72614 100644
--- a/c-scape/src/lib.rs
+++ b/c-scape/src/lib.rs
@@ -1,14 +1,17 @@
 #![doc = include_str!("../README.md")]
+// c-scape does not use std; features that depend on std are in c-gull instead.
 #![no_std]
+// Nightly Rust features that we depend on.
 #![feature(thread_local)] // for `pthread_getspecific` etc.
-#![feature(c_variadic)] // for `ioctl` etc.
-#![cfg_attr(feature = "use-compiler-builtins", feature(rustc_private))]
+#![feature(c_variadic)] // for `printf`, `ioctl`, etc.
+#![feature(sync_unsafe_cell)] // for lots of libc static variables
+#![feature(linkage)] // for `malloc` etc.
+#![feature(naked_functions)] // for `setjmp` etc.
+// Enable strict provenance.
 #![feature(strict_provenance)]
 #![feature(exposed_provenance)]
-#![feature(sync_unsafe_cell)]
-#![feature(linkage)]
-#![feature(naked_functions)]
 #![deny(fuzzy_provenance_casts, lossy_provenance_casts)]
+// Disable some common warnings.
 #![allow(unexpected_cfgs)]
 // Don't warn if `try_into()` is fallible on some targets.
 #![allow(unreachable_patterns)]
@@ -22,8 +25,6 @@ compile_error!("Enable only one of \"coexist-with-libc\" and \"take-charge\".");
 compile_error!("Enable one \"coexist-with-libc\" and \"take-charge\".");
 
 extern crate alloc;
-#[cfg(feature = "use-compiler-builtins")]
-extern crate compiler_builtins;
 
 // Re-export the libc crate's API. This allows users to depend on the c-scape
 // crate in place of libc.
@@ -52,59 +53,47 @@ mod sync_ptr;
 use core::ptr::addr_of;
 use errno::{set_errno, Errno};
 
-mod brk;
-mod ctype;
-mod env;
-mod fs;
-mod io;
-mod shm;
-
-#[cfg(feature = "take-charge")]
-mod malloc;
-
-mod math;
-mod mem;
-
-#[cfg(not(target_os = "wasi"))]
-mod mm;
-
-mod net;
-
-#[cfg(not(target_os = "wasi"))]
-mod process;
-
-mod rand;
-mod rand48;
-#[cfg(not(target_os = "wasi"))]
-#[cfg(feature = "take-charge")]
-mod signal;
-mod termios_;
-
-#[cfg(feature = "thread")]
-#[cfg(feature = "take-charge")]
-mod thread;
-
 mod arpa_inet;
 mod atoi;
 mod base64;
+mod brk;
+mod ctype;
+mod env;
 mod errno_;
 mod error;
 mod exec;
 #[cfg(feature = "take-charge")]
 mod exit;
+mod fs;
 mod glibc_versioning;
 mod int;
+mod io;
 mod jmp;
 mod locale;
+#[cfg(feature = "take-charge")]
+mod malloc;
+mod math;
+mod mem;
 mod mkostemps;
+#[cfg(not(target_os = "wasi"))]
+mod mm;
+mod net;
 mod nss;
 mod path;
 mod pause;
 mod posix_spawn;
+#[cfg(not(target_os = "wasi"))]
+mod process;
 mod process_;
 mod pty;
+mod rand;
+mod rand48;
 mod rand_;
 mod regex;
+mod shm;
+#[cfg(not(target_os = "wasi"))]
+#[cfg(feature = "take-charge")]
+mod signal;
 mod sort;
 #[cfg(feature = "take-charge")]
 mod stdio;
@@ -112,6 +101,10 @@ mod strtod;
 mod strtol;
 mod syscall;
 mod system;
+mod termios_;
+#[cfg(feature = "thread")]
+#[cfg(feature = "take-charge")]
+mod thread;
 mod time;
 
 #[cfg(feature = "deprecated-and-unimplemented")]