Clarify FIXME comments

Author: reddevilmidzy

.github/workflows/failures.yml

@@ -1,4 +1,4 @@
-# FIXME: refactor to avoid duplication with the ci.yml file.
+# FIXME: This workflow duplicates ci.yml.
 name: Failures
 
 on:
@@ -94,15 +94,15 @@ jobs:
       run: ./y.sh prepare
 
     - name: Run tests
-      # FIXME: re-enable those tests for libgccjit 12.
+      # FIXME: libgccjit 12 still fails these tests.
       if: matrix.libgccjit_version.gcc != 'libgccjit12.so'
       id: tests
       run: |
         ${{ matrix.libgccjit_version.env_extra }} ./y.sh test --release --clean --build-sysroot --test-failing-rustc ${{ matrix.libgccjit_version.extra }} 2>&1 | tee output_log
         rg --text "test result" output_log >> $GITHUB_STEP_SUMMARY
 
     - name: Run failing ui pattern tests for ICE
-      # FIXME: re-enable those tests for libgccjit 12.
+      # FIXME: libgccjit 12 still fails these tests.
       if: matrix.libgccjit_version.gcc != 'libgccjit12.so'
       id: ui-tests
       run: |

.github/workflows/m68k.yml

@@ -1,4 +1,4 @@
-# FIXME: check if qemu-user-static-binfmt is needed (perhaps to run some tests since it probably calls exec).
+# FIXME: It is still unclear whether qemu-user-static-binfmt is required for tests that call exec.
 
 name: m68k CI
 
@@ -24,7 +24,7 @@ jobs:
       matrix:
         commands: [
           "--std-tests",
-          # FIXME(antoyo): fix those on m68k.
+          # FIXME(antoyo): These tests are still broken on m68k.
           #"--test-libcore",
           #"--extended-rand-tests",
           #"--extended-regex-example-tests",

.github/workflows/stdarch.yml

@@ -38,7 +38,7 @@ jobs:
     - name: Install packages
       run: sudo apt-get install ninja-build ripgrep
 
-    # FIXME: remove when we have binutils version 2.43 in the repo.
+    # FIXME: This binutils workaround is required until the repo ships binutils 2.43.
     - name: Install more recent binutils
       run: |
         echo "deb http://archive.ubuntu.com/ubuntu plucky main universe" | sudo tee /etc/apt/sources.list.d/plucky-copies.list
@@ -96,7 +96,7 @@ jobs:
       if: ${{ matrix.cargo_runner }}
       run: |
         # FIXME: these tests fail when the sysroot is compiled with LTO because of a missing symbol in proc-macro.
-        # FIXME: remove --skip test_tile_ when it's implemented.
+        # FIXME: test_tile_ must stay skipped until the tile builtins are implemented.
         STDARCH_TEST_SKIP_FUNCTION="xsave,xsaveopt,xsave64,xsaveopt64" STDARCH_TEST_EVERYTHING=1 CHANNEL=release CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_RUNNER="${{ matrix.cargo_runner }}" TARGET=x86_64-unknown-linux-gnu CG_RUSTFLAGS="-Ainternal_features" ./y.sh cargo test --manifest-path build/build_sysroot/sysroot_src/library/stdarch/Cargo.toml -- --skip rtm --skip tbm --skip sse4a --skip test_tile_
 
   # Summary job for the merge queue.

build_system/src/prepare.rs

@@ -148,7 +148,7 @@ fn prepare_libcore(
     Ok(())
 }
 
-// FIXME: remove when we can ignore warnings in rustdoc tests.
+// FIXME: This workaround is still required because rustdoc tests cannot ignore warnings.
 fn prepare_rand() -> Result<(), String> {
     // Apply patch for the rand crate.
     let file_path = "patches/crates/0001-Remove-deny-warnings.patch";

build_system/src/test.rs

@@ -286,7 +286,7 @@ fn build_sysroot(env: &Env, args: &TestArg) -> Result<(), String> {
     Ok(())
 }
 
-// FIXME(GuillaumeGomez): when rewriting in Rust, refactor with the code in tests/lang_tests_common.rs if possible.
+// FIXME(GuillaumeGomez): This still duplicates tests/lang_tests_common.rs; keep them in sync until the Rust rewrite.
 fn maybe_run_command_in_vm(
     command: &[&dyn AsRef<OsStr>],
     env: &Env,
@@ -708,16 +708,16 @@ fn test_projects(env: &Env, args: &TestArg) -> Result<(), String> {
         "https://github.com/BurntSushi/memchr",
         "https://github.com/dtolnay/itoa",
         "https://github.com/rust-lang/cfg-if",
-        //"https://github.com/rust-lang-nursery/lazy-static.rs", // FIXME: re-enable when the
+        //"https://github.com/rust-lang-nursery/lazy-static.rs", // FIXME: This stays disabled until the
         //failing test is fixed upstream.
         //"https://github.com/marshallpierce/rust-base64", // FIXME: one test is OOM-killed.
-        // FIXME: ignore the base64 test that is OOM-killed.
+        // FIXME: The OOM-killed base64 test still needs to be ignored.
         //"https://github.com/time-rs/time", // FIXME: one test fails (https://github.com/time-rs/time/issues/719).
         "https://github.com/rust-lang/log",
         "https://github.com/bitflags/bitflags",
         //"https://github.com/serde-rs/serde", // FIXME: one test fails.
-        //"https://github.com/rayon-rs/rayon", // FIXME: very slow, only run on master?
-        //"https://github.com/rust-lang/cargo", // FIXME: very slow, only run on master?
+        //"https://github.com/rayon-rs/rayon", // FIXME: This is too slow for regular CI runs; keep it for master-only runs if re-enabled.
+        //"https://github.com/rust-lang/cargo", // FIXME: This is too slow for regular CI runs; keep it for master-only runs if re-enabled.
     ];
 
     let mut env = env.clone();
@@ -759,7 +759,7 @@ fn test_libcore(env: &Env, args: &TestArg) -> Result<(), String> {
     println!("[TEST] libcore");
     let path = get_sysroot_dir().join("sysroot_src/library/coretests");
     let _ = remove_dir_all(path.join("target"));
-    // FIXME(antoyo): run in release mode when we fix the failures.
+    // FIXME(antoyo): test_libcore still fails in release mode.
     run_cargo_command(&[&"test"], Some(&path), env, args)?;
     Ok(())
 }

doc/debugging-libgccjit.md

@@ -71,4 +71,4 @@ Maybe by calling the following at the beginning of gdb:
 set substitute-path /usr/src/debug/gcc /path/to/gcc-repo/gcc
 ```
 
-FIXME(antoyo): but that's not what I remember I was doing.
+FIXME(antoyo): These debugging notes are stale; this is not what I remember doing.

doc/subtree.md

@@ -47,6 +47,6 @@ git push
 PATH="$HOME/bin:$PATH" ~/bin/git-subtree push -P compiler/rustc_codegen_gcc/ ../rustc_codegen_gcc/ sync_branch_name
 ```
 
-FIXME: write a script that does the above.
+FIXME: This subtree push flow is still manual.
 
 https://rust-lang.zulipchat.com/#narrow/stream/301329-t-devtools/topic/subtree.20madness/near/258877725

example/mini_core_hello_world.rs

@@ -275,7 +275,7 @@ fn main() {
         }
     }
 
-    // FIXME(antoyo): to make this work, support weak linkage.
+    // FIXME(antoyo): This example still depends on unsupported weak linkage.
     //unsafe { assert_eq!(ABC as usize, 0); }
 
     &mut (|| Some(0 as *const ())) as &mut dyn FnMut() -> Option<*const ()>;

src/abi.rs

@@ -105,7 +105,7 @@ pub struct FnAbiGcc<'gcc> {
 }
 
 pub trait FnAbiGccExt<'gcc, 'tcx> {
-    // FIXME(antoyo): return a function pointer type instead?
+    // FIXME(antoyo): This should return a function pointer type instead of the current representation.
     fn gcc_type(&self, cx: &CodegenCx<'gcc, 'tcx>) -> FnAbiGcc<'gcc>;
     fn ptr_to_gcc_type(&self, cx: &CodegenCx<'gcc, 'tcx>) -> Type<'gcc>;
     #[cfg(feature = "master")]
@@ -260,7 +260,7 @@ pub fn conv_to_fn_attribute<'gcc>(conv: CanonAbi, arch: &Arch) -> Option<FnAttri
             &Arch::Nvptx64 => FnAttribute::NvptxKernel,
             arch => panic!("Arch {arch} does not support GpuKernel calling convention"),
         },
-        // FIXME(antoyo): check if those AVR attributes are mapped correctly.
+        // FIXME(antoyo): The AVR attribute mapping is still unverified.
         CanonAbi::Interrupt(interrupt_kind) => match interrupt_kind {
             InterruptKind::Avr => FnAttribute::AvrSignal,
             InterruptKind::AvrNonBlocking => FnAttribute::AvrInterrupt,

src/allocator.rs

@@ -98,7 +98,7 @@ fn create_wrapper_function(
     )));
 
     if tcx.sess.must_emit_unwind_tables() {
-        // FIXME(antoyo): emit unwind tables.
+        // FIXME(antoyo): Unwind tables are still not emitted here.
     }
 
     let block = func.new_block("entry");
@@ -138,6 +138,6 @@ fn create_wrapper_function(
         block.end_with_void_return(None);
     }
 
-    // FIXME(@Commeownist): Check if we need to emit some extra debugging info in certain circumstances
+    // FIXME(@Commeownist): Some cases may still be missing extra debugging info here
     // as described in https://github.com/rust-lang/rust/commit/77a96ed5646f7c3ee8897693decc4626fe380643
 }