From a93cefe2cfb44a1343ce9ee42d2555742458834e Mon Sep 17 00:00:00 2001
From: Doonv <58695417+doonv@users.noreply.github.com>
Date: Thu, 25 Jan 2024 21:07:51 +0200
Subject: [PATCH] Improve `config_fast_builds.toml` (#11529)

# Objective

Theres no explaination for what the compiler flags
`config_fast_builds.toml` do

## Solution

Explain what the flags in `config_fast_builds.toml` do.
---
 .cargo/config_fast_builds.toml | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/.cargo/config_fast_builds.toml b/.cargo/config_fast_builds.toml
index 5993b536d5..39fb262fbc 100644
--- a/.cargo/config_fast_builds.toml
+++ b/.cargo/config_fast_builds.toml
@@ -5,26 +5,27 @@
 
 [target.x86_64-unknown-linux-gnu]
 linker = "clang"
-rustflags = ["-Clink-arg=-fuse-ld=lld", "-Zshare-generics=y"]
+rustflags = [
+  "-Clink-arg=-fuse-ld=lld", # Use LLD Linker
+  "-Zshare-generics=y",      # (Nightly) Make the current crate share its generic instantiations
+]
 
 # NOTE: you must install [Mach-O LLD Port](https://lld.llvm.org/MachO/index.html) on mac. you can easily do this by installing llvm which includes lld with the "brew" package manager:
 # `brew install llvm`
 [target.x86_64-apple-darwin]
 rustflags = [
-  "-C",
-  "link-arg=-fuse-ld=/usr/local/opt/llvm/bin/ld64.lld",
-  "-Zshare-generics=y",
+  "-Clink-arg=-fuse-ld=/usr/local/opt/llvm/bin/ld64.lld", # Use LLD Linker
+  "-Zshare-generics=y",                                   # (Nightly) Make the current crate share its generic instantiations
 ]
 
 [target.aarch64-apple-darwin]
 rustflags = [
-  "-C",
-  "link-arg=-fuse-ld=/opt/homebrew/opt/llvm/bin/ld64.lld",
-  "-Zshare-generics=y",
+  "-Clink-arg=-fuse-ld=/opt/homebrew/opt/llvm/bin/ld64.lld", # Use LLD Linker
+  "-Zshare-generics=y",                                      # (Nightly) Make the current crate share its generic instantiations
 ]
 
 [target.x86_64-pc-windows-msvc]
-linker = "rust-lld.exe"
+linker = "rust-lld.exe"            # Use LLD Linker
 rustflags = ["-Zshare-generics=n"]
 
 # Optional: Uncommenting the following improves compile times, but reduces the amount of debug info to 'line number tables only'