aboutsummaryrefslogtreecommitdiff
path: root/AGENTS
diff options
context:
space:
mode:
author_ov4 <ov4@ov4.org>2026-10-13 12:32:56 +0000
committer_ov4 <ov4@ov4.org>2026-10-13 12:32:56 +0000
commit5b08d59dba28b99cf991c02e837297fbfdb190c9 (patch)
tree2fa442c7949a69193bea82334d8d705e06e5cb55 /AGENTS
parent17cec530b0a4d792bde2d37583b6c26e89f9b1bd (diff)
feat: point command-line help to the platform manual
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Diffstat (limited to 'AGENTS')
-rw-r--r--AGENTS/ARCH.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/AGENTS/ARCH.md b/AGENTS/ARCH.md
index 8245027..247bce1 100644
--- a/AGENTS/ARCH.md
+++ b/AGENTS/ARCH.md
@@ -59,6 +59,9 @@ Driver behavior (`tools/driver/main.cc`):
- One source file, with optional `-o path` and `-r`; options may precede or follow the source.
No stdin source input. Missing input, including no arguments, prints
`cpsc: fatal error: no input files` and `compilation terminated.`, then returns 1.
+- `-h` anywhere in the arguments prints one documentation pointer to stdout and
+ returns 0 without compiling: `man 1 cpsc` on Unix/macOS, or
+ Start Menu > cpsc > cpsc Help on Windows (selected by `_WIN32`).
- IR is written only after successful parsing, code generation and module
verification. Diagnostics stay on stderr; failures do not overwrite existing IR.
- Lexer, Parser and CodeGen track error flags (`hadError()`); any error, including