[PR #6982] [CLOSED] docs(cutter): document REA_CUTTER_BRIDGE_DIR and default locations #7491

Closed
opened 2026-11-01 21:48:13 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6982
Author: @ahmed-husssain
Created: 10/24/2026
Status: ❌ Closed

Base: main ← Head: docs/cutter-bridge-directory


📝 Commits (1)

  • 3a9a596 docs(cutter): document REA_CUTTER_BRIDGE_DIR and default locations

📊 Changes

1 file changed (+7 additions, -0 deletions)

View changed files

📝 docs/reverse-engineering-tools.md (+7 -0)

📄 Description

Summary

Fixes #6961

Documents REA_CUTTER_BRIDGE_DIR, leading ~ expansion, and the platform-specific default bridge directory locations for both the Cutter bridge plugin and TypeScript client in docs/reverse-engineering-tools.md.

Problem and expected behavior

While REA_CUTTER_BRIDGE_DIR is implemented in bridge/cutter/rea_bridge.py and src/cutter/CutterBridgeClient.ts and exercised in boundary tests, docs/reverse-engineering-tools.md only documented payload limits and candidate limits without mentioning where descriptors are stored or how to customize the directory.

Change and scope

Added concise documentation under the ## Cutter bridge section describing:

  • Resolution from REA_CUTTER_BRIDGE_DIR with leading ~ expanded.
  • Default path on Windows when LOCALAPPDATA is set (%LOCALAPPDATA%\REA\CutterBridge).
  • Default path on other platforms or fallback (~/.cache/rea/cutter-bridge).
  • Operational note that different values across processes cause discovery to search a different directory from the one Cutter writes to.

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation (docs/reverse-engineering-tools.md)
  • Contribution scope fit and linked maintainer decision: not applicable (documentation only)
  • CLI and MCP/tool-catalog contract: unchanged
  • Provider, bridge, target-format, or platform compatibility: documents existing cross-platform behavior
  • Evidence, artifact, provenance, or reconstruction contract: none
  • Target selection, authority, upstream behavior, and cleanup details: not applicable
  • Generated metadata, package, or installation impact: none

Expected effects:

  • Documentation or usability only; no target interaction.

Evidence and regression coverage

  • Tests added or updated: documentation conformance checks
  • Base reproduction or other evidence: verified against bridge/cutter/rea_bridge.py (_bridge_directory) and src/cutter/CutterBridgeClient.ts (resolveBridgeDirectory)
  • User-visible CLI/MCP output: not applicable
  • Remaining proof gaps: none

Validation performed

  • npm run docs:check — 6 turbo tasks successful, 9/9 readme conformance tests passed
  • npm run check:fast — typecheck and linting passed with 0 errors

Compatibility, safety, and release

  • Breaking changes or migration steps: none
  • Real Hopper/Ghidra, browser, or OS coverage: documentation only
  • Package or release metadata impact: none
  • Security, privacy, process, or containment review: none

Author readiness

Human owner: @ahmed-husssain

  • 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.

🔄 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/6982 **Author:** [@ahmed-husssain](https://github.com/ahmed-husssain) **Created:** 10/24/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/cutter-bridge-directory` --- ### 📝 Commits (1) - [`3a9a596`](https://github.com/morluto/rea/commit/3a9a5961d6f2192df0cd215faf17b8f807983d64) docs(cutter): document REA_CUTTER_BRIDGE_DIR and default locations ### 📊 Changes **1 file changed** (+7 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/reverse-engineering-tools.md` (+7 -0) </details> ### 📄 Description ## Summary Fixes #6961 Documents `REA_CUTTER_BRIDGE_DIR`, leading `~` expansion, and the platform-specific default bridge directory locations for both the Cutter bridge plugin and TypeScript client in `docs/reverse-engineering-tools.md`. ## Problem and expected behavior While `REA_CUTTER_BRIDGE_DIR` is implemented in `bridge/cutter/rea_bridge.py` and `src/cutter/CutterBridgeClient.ts` and exercised in boundary tests, `docs/reverse-engineering-tools.md` only documented payload limits and candidate limits without mentioning where descriptors are stored or how to customize the directory. ## Change and scope Added concise documentation under the `## Cutter bridge` section describing: - Resolution from `REA_CUTTER_BRIDGE_DIR` with leading `~` expanded. - Default path on Windows when `LOCALAPPDATA` is set (`%LOCALAPPDATA%\REA\CutterBridge`). - Default path on other platforms or fallback (`~/.cache/rea/cutter-bridge`). - Operational note that different values across processes cause discovery to search a different directory from the one Cutter writes to. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation (`docs/reverse-engineering-tools.md`) - Contribution scope fit and linked maintainer decision: not applicable (documentation only) - CLI and MCP/tool-catalog contract: unchanged - Provider, bridge, target-format, or platform compatibility: documents existing cross-platform behavior - Evidence, artifact, provenance, or reconstruction contract: none - Target selection, authority, upstream behavior, and cleanup details: not applicable - Generated metadata, package, or installation impact: none Expected effects: - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: documentation conformance checks - Base reproduction or other evidence: verified against `bridge/cutter/rea_bridge.py` (`_bridge_directory`) and `src/cutter/CutterBridgeClient.ts` (`resolveBridgeDirectory`) - User-visible CLI/MCP output: not applicable - Remaining proof gaps: none ## Validation performed - `npm run docs:check` — 6 turbo tasks successful, 9/9 readme conformance tests passed - `npm run check:fast` — typecheck and linting passed with 0 errors ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: documentation only - Package or release metadata impact: none - Security, privacy, process, or containment review: none ## Author readiness Human owner: @ahmed-husssain - [ ] 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 - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:48:13 +00:00
Sign in to join this conversation.
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#7491
No description provided.