morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #4068] [MERGED] docs(objdump): show debug-link flag forms that keep their meaning #6031

New issue

Closed

opened 2026-10-31 01:11:19 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:11:19 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4068
Author: @kaoru0822-kitauji
Created: 10/15/2026
Status: ✅ Merged
Merged: 10/15/2026
Merged by: @morluto

Base: main ← Head: docs/3893-follow-debug-links

📝 Commits (1)

8f81c47 docs(objdump): show debug-link flag forms that keep their meaning

📊 Changes

1 file changed (+3 additions, -2 deletions)

View changed files

📝 docs/reverse-engineering-tools.md (+3 -2)

📄 Description

Summary

Fixes #3893. The objdump DWARF example in docs/reverse-engineering-tools.md passed --follow-debug-links false, which reads as disabling debug-link following. The CLI parses the option as a Boolean flag and drops the separate false word, so the documented command did the opposite and passed -WK. The docs now show forms that do what they say.

Problem and expected behavior

All of these were executed with the built CLI on /bin/ls (inspect-with-objdump … dwarf … --filter-output parameters.follow_debug_links,parameters.command_arguments --json):

form	`follow_debug_links`	objdump args
option omitted	`false`	`-W -WN`
`--follow-debug-links`	`true`	`-W -WK`
`--no-follow-debug-links`	`false`	`-W -WN`
`--follow-debug-links=false`	`false`	`-W -WN`
`--follow-debug-links false` (old documented example)	`true`	`-W -WK`

The prose also said "The CLI option is --follow-debug-links true". That form only works because the stray true is dropped.

Change and scope

The example now shows the default command and the bare --follow-debug-links flag.
The prose names the flag and its negations (--no-follow-debug-links, --follow-debug-links=false), and states that a separate true or false word is not its value.
A repository-wide search found no other spaced --flag true|false examples, and no other file mentions this flag.
Not changed: the root cause of the silent acceptance. incur 0.6.1 assigns positionals to the args schema in order and discards extras before validation (node_modules/incur/dist/Parser.js, positional assignment). As a result, any command silently ignores an unexpected trailing positional; for example inspect-go-binary /bin/ls extra-positional succeeds. Rejecting extra positionals is a CLI-wide parser behavior change that belongs in incur or needs a maintainer decision, so it is out of scope here.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only.
Contribution scope fit and linked maintainer decision: not applicable.
CLI and MCP/tool-catalog contract: unchanged.
Provider, bridge, target-format, or platform compatibility: none.
Evidence, artifact, provenance, or reconstruction contract: none.
Target selection, authority, upstream behavior, and cleanup details: not applicable.
Generated metadata, package, or installation impact: none.
Documentation or usability only; no target interaction.

Evidence and regression coverage

Tests added or updated: none (documentation only). The table above is the executed check of every form the docs now name.
Base reproduction: the documented --follow-debug-links false recorded follow_debug_links: true and -WK, matching the issue.
Output size and time: not applicable; no runtime change.
Remaining proof gaps: GNU binutils objdump behavior with -WK was not exercised against a binary with real debug links. Only the recorded parameters and arguments were checked.

Validation performed

zsh loop over the five forms above with the built CLI — results as tabulated.
npx oxfmt --check docs/reverse-engineering-tools.md — passed.
npm run docs:check — passed.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: macOS arm64 objdump argument construction only.
Package or release metadata impact: none.
Security, privacy, process, or containment review: users who copied the old example unintentionally enabled following external debug links. The corrected example keeps the safer default.

Author readiness

Human owner:

I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
I declare this PR ready for initial maintainer review.

Before merge

This PR addresses a concrete problem or an agreed enhancement.
Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Tests cover changed observable behavior and meaningful failure paths.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

🤖 Generated with Claude Code

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/4068 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/15/2026 **Status:** ✅ Merged **Merged:** 10/15/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/3893-follow-debug-links` --- ### 📝 Commits (1) - [`8f81c47`](https://github.com/morluto/rea/commit/8f81c47c6daa509b68afd0e22711e9c267a28849) docs(objdump): show debug-link flag forms that keep their meaning ### 📊 Changes **1 file changed** (+3 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `docs/reverse-engineering-tools.md` (+3 -2) </details> ### 📄 Description ## Summary Fixes #3893. The objdump DWARF example in `docs/reverse-engineering-tools.md` passed `--follow-debug-links false`, which reads as disabling debug-link following. The CLI parses the option as a Boolean flag and drops the separate `false` word, so the documented command did the opposite and passed `-WK`. The docs now show forms that do what they say. ## Problem and expected behavior All of these were executed with the built CLI on `/bin/ls` (`inspect-with-objdump … dwarf … --filter-output parameters.follow_debug_links,parameters.command_arguments --json`): | form | `follow_debug_links` | objdump args | |---|---|---| | option omitted | `false` | `-W -WN` | | `--follow-debug-links` | `true` | `-W -WK` | | `--no-follow-debug-links` | `false` | `-W -WN` | | `--follow-debug-links=false` | `false` | `-W -WN` | | `--follow-debug-links false` (old documented example) | `true` | `-W -WK` | The prose also said "The CLI option is `--follow-debug-links true`". That form only works because the stray `true` is dropped. ## Change and scope - The example now shows the default command and the bare `--follow-debug-links` flag. - The prose names the flag and its negations (`--no-follow-debug-links`, `--follow-debug-links=false`), and states that a separate `true` or `false` word is not its value. - A repository-wide search found no other spaced `--flag true|false` examples, and no other file mentions this flag. - Not changed: the root cause of the silent acceptance. incur 0.6.1 assigns positionals to the args schema in order and discards extras before validation (`node_modules/incur/dist/Parser.js`, positional assignment). As a result, any command silently ignores an unexpected trailing positional; for example `inspect-go-binary /bin/ls extra-positional` succeeds. Rejecting extra positionals is a CLI-wide parser behavior change that belongs in incur or needs a maintainer decision, so it is out of scope here. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only. - Contribution scope fit and linked maintainer decision: not applicable. - CLI and MCP/tool-catalog contract: unchanged. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details: not applicable. - Generated metadata, package, or installation impact: none. - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: none (documentation only). The table above is the executed check of every form the docs now name. - Base reproduction: the documented `--follow-debug-links false` recorded `follow_debug_links: true` and `-WK`, matching the issue. - Output size and time: not applicable; no runtime change. - Remaining proof gaps: GNU binutils objdump behavior with `-WK` was not exercised against a binary with real debug links. Only the recorded parameters and arguments were checked. ## Validation performed - `zsh` loop over the five forms above with the built CLI — results as tabulated. - `npx oxfmt --check docs/reverse-engineering-tools.md` — passed. - `npm run docs:check` — passed. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: macOS arm64 objdump argument construction only. - Package or release metadata impact: none. - Security, privacy, process, or containment review: users who copied the old example unintentionally enabled following external debug links. The corrected example keeps the safer default. ## Author readiness Human owner:  - [ ] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [ ] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [ ] I declare this PR ready for initial maintainer review. ## Before merge - [ ] This PR addresses a concrete problem or an agreed enhancement. - [ ] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [ ] The PR has one focused outcome and the title follows `type(scope): outcome`. - [ ] Related issue is linked, or the reason for not linking one is stated above. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [ ] Owning docs, contracts, and generated metadata are updated where needed. - [ ] User-visible CLI/MCP changes include representative output. - [ ] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:11:19 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-03 13:39:13 +00:00

[PR #7081] [MERGED] fix(ghidra): report a DOL language override conflict as a configuration error #7628

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#6031

No description provided.

Rows
Columns