From d532a9b880d36571d3fa98d075589ff7483922bc Mon Sep 17 00:00:00 2001
From: Johannes Stoelp <johannes.stoelp@gmail.com>
Date: Fri, 21 Feb 2025 22:36:34 +0100
Subject: gcc: cli opts + sanitizer

---
 src/development/gcc.md | 28 ++++++++++++++++++++++++----
 1 file changed, 24 insertions(+), 4 deletions(-)

diff --git a/src/development/gcc.md b/src/development/gcc.md
index 7d34ac3..a0925c5 100644
--- a/src/development/gcc.md
+++ b/src/development/gcc.md
@@ -2,6 +2,15 @@
 
 ## CLI
 
+- `-v` verbose, outputs exact compiler/linker invocations made by the gcc driver
+- `-###` dry-run, outputting exact compiler/linker invocations
+- `-print-multi-lib` print available multilib configurations
+- `--help=<class>` print description of cmdline options for given class, eg
+  `warnings`, `optimizers`, `target`, `c`, `c++`
+- `-Wl,<opt>` additional option passed to the linker invocation (can
+  be specified multiple times)
+- `-Wl,--trace` trace each file the linker touches
+
 ### Preprocessing
 While debugging can be helpful to just pre-process files.
 
@@ -10,10 +19,6 @@ gcc -E [-dM] ...
 ```
 - `-E` run only preprocessor
 - `-dM` list only `#define` statements
-- `-###` dry-run, outputting exact compiler/linker invocations
-- `-print-multi-lib` print available multilib configurations
-- `--help=<class>` print description of cmdline options for given class, eg
-  `warnings`, `optimizers`, `target`, `c`, `c++`
 
 ### Target options
 ```bash
@@ -35,6 +40,21 @@ gcc --help=optimizers
 # instead showing their description.
 ```
 
+### Sanitizer
+```bash
+# Enable address sanitizer, a memory error checker (out of bounds, use after free, ..).
+gcc -fsanitize=address ...
+
+# Enable leak sanitizer, a memory leak detector.
+gcc -fsanitize=leak
+
+# Enable undefined behavior sanitizer, detects various UBs (integer overflow, ..).
+gcc -fsanitize=undefined ...
+
+# Enable thread sanitizer, a data race detector.
+gcc -fsanitize=thread
+```
+
 ## [Builtins][builtins]
 
 ### `__builtin_expect(expr, cond)`
-- 
cgit v1.2.3