Record your work
glaurung comment
Show, add, or delete a comment at an address.
use it for
Omit the text to read the current comment. Use --delete to remove it.
Run glaurung comment --help on your installed version before putting the command in a script.
Glaurung is still pre-1.0.
- input
- A project, address or function name, and optional comment text.
- output
- An address comment with provenance. Omitting text reads the current value.
- mode
- writes state. Adding or deleting a comment updates the project.
command shape
syntax
$ glaurung comment PROJECT VA [TEXT ...] [--delete]
The installed parser is authoritative: glaurung comment --help
before the examples
project setup
The examples use the checked-in hello-c-clang-debug fixture and a
project named hello.glaurung.
$ glaurung kickoff samples/binaries/platforms/linux/amd64/export/native/clang/debug/hello-c-clang-debug --db hello.glaurungrun it
examples
Attach a claim to main
Comments belong at the address whose instructions support the claim.
run
$ glaurung comment hello.glaurung 0x1150 reviews argv and prints a total --binary samples/binaries/platforms/linux/amd64/export/native/clang/debug/hello-c-clang-debugoutput
0x1150: reviews argv and prints a total [manual]captured 2026-08-31.
Read the result: The manual tag records who asserted the text. The comment is an annotation, not a replacement for the disassembly that supports it.
Read or remove it
Omit the body to inspect the current comment. Add --delete only when you intend a write.
run
$ glaurung comment hello.glaurung 0x1150output
0x1150: reviews argv and prints a total [manual]captured 2026-08-31.
Read the result: This form is read-only because it has no body and no --delete flag. It returns the current canonical comment and provenance.
used above
important options
These are the flags used by the examples. Run glaurung comment --help for the complete parser help.
before you rely on it
checks
keep working