From cb18d4c9c4ee399d81ebaf0888117d52d990e442 Mon Sep 17 00:00:00 2001 From: Kaoru0822 Date: Thu, 15 Oct 2026 03:07:09 -0700 Subject: [PATCH] docs(objdump): show debug-link flag forms that keep their meaning (#4068) The DWARF example passed `--follow-debug-links false`. The CLI parses the option as a Boolean flag and drops the separate `false` word, so the documented command enabled debug-link following (`-WK`). Show the default and the bare flag, and name `--no-follow-debug-links` and `--follow-debug-links=false` as the forms that keep it disabled. Fixes #3893 Co-authored-by: Claude Opus 5.5 --- docs/reverse-engineering-tools.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/reverse-engineering-tools.md b/docs/reverse-engineering-tools.md index 124c92dc0b..3373526c9d 100644 --- a/docs/reverse-engineering-tools.md +++ b/docs/reverse-engineering-tools.md @@ -16,11 +16,12 @@ can run. `inspect_with_objdump` and `rea inspect-with-objdump` capture stdout and stderr as inline Evidence. Artifact inspection Evidence records SHA-256 digests before and after the provider call and whether those observed digests differ; this cannot prove the exact bytes consumed if the artifact changes during execution. Choose one artifact operation: `file_headers`, `section_headers`, `symbols`, `relocations`, `dwarf`, `disassemble`, or `disassemble_all`. `disassemble` maps to `-d`; `disassemble_all` maps to `-D` and has different symbol-boundary semantics. The pathless `inspect_with_objdump {"operation":"architectures"}` MCP call or `rea list-objdump-architectures` CLI command maps to `-i` and produces subjectless provider-capability Evidence describing BFD targets compiled into the installed binary, not a guarantee that a target is supported. -For DWARF, REA does not follow local debug links by default. Set `follow_debug_links` to `true` to pass `-WK`; external debug-file identities are not bound to Evidence when following links is enabled. The CLI option is `--follow-debug-links true`. REA clears `DEBUGINFOD_URLS` in the objdump child environment to disable debuginfod network access on GNU binutils versions that do not support `-WE`. The complete raw output is authoritative; REA does not normalize it into a version-independent disassembly schema. +For DWARF, REA does not follow local debug links by default. Set `follow_debug_links` to `true` to pass `-WK`; external debug-file identities are not bound to Evidence when following links is enabled. The CLI flag is `--follow-debug-links`; `--no-follow-debug-links` or `--follow-debug-links=false` keeps the default. A separate `true` or `false` word after the flag is not its value. REA clears `DEBUGINFOD_URLS` in the objdump child environment to disable debuginfod network access on GNU binutils versions that do not support `-WE`. The complete raw output is authoritative; REA does not normalize it into a version-independent disassembly schema. ```sh rea inspect-with-objdump ./program disassemble -rea inspect-with-objdump ./program dwarf --follow-debug-links false +rea inspect-with-objdump ./program dwarf +rea inspect-with-objdump ./program dwarf --follow-debug-links ``` Captured stdout and stderr are retained up to a 16 MiB combined limit; `output_truncated` marks output beyond that limit.