petrbalvin/gasm-sdk
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 36 Wiki Activity

docs: drop process labels and refresh the architecture and manual pages

Browse Source 
Assisted-by: GLM 5.3
This commit is contained in:
petrbalvin
2026-09-19 23:49:27 +02:00
parent 7604a9443f
commit 3a73acb20a
19 changed files with 123 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/man/gasm-asm.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-ASM 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-ASM 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-asm \- assemble Plan 9 assembly without the Go toolchain
.SH SYNOPSIS
docs/man/gasm-audit-instructions.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-AUDIT-INSTRUCTIONS 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-AUDIT-INSTRUCTIONS 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-audit-instructions \- diff the encoder against the Go toolchain, or measure a corpus
.SH SYNOPSIS
docs/man/gasm-debug.1
+6 -4
View File
@@ -1,4 +1,4 @@
.TH GASM-DEBUG 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-DEBUG 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-debug \- interactive source-level debugger for JIT-assembled functions
.SH SYNOPSIS
@@ -98,10 +98,12 @@ Run REPL commands from a file (one per line) and exit; - reads stdin.
.TP
.B \-timeout \fIduration\fR
Kill the debuggee after this duration (e.g. 30s); for headless --script
runs.
runs; a timeout exits 3.
.SH EXIT STATUS
Exits 0 when the scripted session completes and 1 when the debuggee
crashes or a check fails; the debugger is Linux-only.
Exits 0 when the scripted session completes, 1 when the debuggee crashes
or a check fails, and 3 when
.B \-\-timeout
kills the debuggee; the debugger is Linux-only.
.SH EXAMPLES
.nf
gasm debug \-\-func name k.s
docs/man/gasm-diff.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-DIFF 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-DIFF 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-diff \- compare the machine code of two assembly files
.SH SYNOPSIS
docs/man/gasm-dis.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-DIS 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-DIS 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-dis \- disassemble machine code to instruction text
.SH SYNOPSIS
docs/man/gasm-fmt.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-FMT 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-FMT 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-fmt \- canonicalise the formatting of Plan 9 assembly sources
.SH SYNOPSIS
docs/man/gasm-lint.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-LINT 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-LINT 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-lint \- run the static checks over assembly files
.SH SYNOPSIS
docs/man/gasm-lsp.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-LSP 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-LSP 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-lsp \- run the Plan 9 assembly language server
.SH SYNOPSIS
docs/man/gasm-parse.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-PARSE 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-PARSE 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-parse \- parse an assembly file and report syntax errors
.SH SYNOPSIS
docs/man/gasm-profile.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-PROFILE 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-PROFILE 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-profile \- show the basic-block structure of functions
.SH SYNOPSIS
docs/man/gasm-scaffold.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-SCAFFOLD 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-SCAFFOLD 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-scaffold \- generate a differential test skeleton for a kernel file
.SH SYNOPSIS
docs/man/gasm-tokens.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-TOKENS 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-TOKENS 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-tokens \- print the lexical token stream of an assembly file
.SH SYNOPSIS
docs/man/gasm-verify.1
+1 -1
View File
@@ -1,4 +1,4 @@
.TH GASM-VERIFY 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM-VERIFY 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm-verify \- JIT-assemble a file and run dynamic checks against it
.SH SYNOPSIS
docs/man/gasm.1
+3 -2
View File
@@ -1,4 +1,4 @@
.TH GASM 1 "2026-09-19" "gasm 0.33.0" "User Commands"
.TH GASM 1 "2026-09-19" "gasm" "User Commands"
.SH NAME
gasm \- developer tooling for Go's Plan 9 assembler
.SH SYNOPSIS
@@ -82,7 +82,8 @@ Show the command overview.
Print the version the toolchain recorded at build time.
.SH EXIT STATUS
Exits 0 on success, 1 when a command fails, and 2 on a usage error. An
unknown command exits 2.
unknown command exits 2; \fBgasm debug\fR exits 3 when \-\-timeout kills
the debuggee.
.SH SEE ALSO
.BR gasm\-asm (1),
.BR gasm\-fmt (1),