[PR #6962] [CLOSED] docs(cutter): document the bridge directory setting #7477

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

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/6962
Author: @viniciusdsandrade
Created: 10/24/2026
Status: ❌ Closed

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


📝 Commits (2)

  • 1cb08ef docs(cutter): document the bridge directory setting
  • 3db650a docs(cutter): name only the shared tilde forms of the bridge directory

📊 Changes

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

View changed files

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

📄 Description

Summary

The Cutter bridge section documents REA_BRIDGE_MAX_REQUEST_BYTES and the descriptor discovery budget, but never names the directory discovery reads or the REA_CUTTER_BRIDGE_DIR setting that both the plugin and the client resolve. This adds one paragraph with the setting, the two default locations, the shared tilde expansion, and the fact that each process reads its own environment.

Fixes #6961

Problem and expected behavior

A reader of the Cutter bridge section cannot learn where discovery looks for session descriptors or how to point the plugin and the client at the same directory. The expected content is a short statement of the setting and its defaults, consistent with bridge/cutter/rea_bridge.py (_bridge_directory) and src/cutter/CutterBridgeClient.ts (resolveBridgeDirectory).

Change and scope

  • docs/reverse-engineering-tools.md: one paragraph after the discovery and deadline limits in the Cutter bridge section.

Documentation only; no code, schema, or generated metadata changes.

Follow the contribution scope.
Unresolved scope, authority, side effects, or required verification block
integration. Link the required maintainer scope decision for new providers or
capabilities involving target execution, injection, mutation, or protection
recovery; ordinary fixes within existing boundaries may state "not applicable".
Draft PRs may leave the scope decision pending and the readiness and merge checklists
unchecked. Maintainers can help resolve open questions.

Contract and boundary impact

  • Semantic owner and earliest changed stage: the Cutter bridge documentation; no runtime stage changes.
  • Contribution scope fit and linked maintainer decision: not applicable (documentation of existing behavior).
  • CLI and MCP/tool-catalog contract: none.
  • Provider, bridge, target-format, or platform compatibility: none; the text describes the current plugin and client behavior at 1d896e03b.
  • Evidence, artifact, provenance, or reconstruction contract: none.
  • Target selection, authority, upstream behavior, and cleanup details (if applicable): none.
  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none.

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none; documentation only.
  • Base reproduction or other evidence: source-derived. bridge/cutter/rea_bridge.py lines 451 to 457 and src/cutter/CutterBridgeClient.ts lines 1170 to 1184 read the variable with the same defaults and tilde handling; rg REA_CUTTER_BRIDGE_DIR docs README.md at 1d896e03b returns nothing.
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: none beyond the rendered-page check CI performs.

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Not an evidence-bearing change.

Validation performed

  • No commands were run locally. The documentation checks in the repository CI on this PR are the executed validation.

Compatibility, safety, and release

  • Breaking changes or migration steps: none.
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable.
  • Package or release metadata impact: none.
  • Security, privacy, process, or containment review: none; the paragraph names default cache locations already present in source.

Author readiness

Human owner: @viniciusdsandrade

  • 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. (Documentation only; no observable behavior changed.)
  • 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/6962 **Author:** [@viniciusdsandrade](https://github.com/viniciusdsandrade) **Created:** 10/24/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/6961-cutter-bridge-directory` --- ### 📝 Commits (2) - [`1cb08ef`](https://github.com/morluto/rea/commit/1cb08efed4f6efc928fe5e5a41d5dd4caaf96ec4) docs(cutter): document the bridge directory setting - [`3db650a`](https://github.com/morluto/rea/commit/3db650aab050df87363363e09deb424028a89f05) docs(cutter): name only the shared tilde forms of the bridge directory ### 📊 Changes **1 file changed** (+11 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/reverse-engineering-tools.md` (+11 -0) </details> ### 📄 Description ## Summary The Cutter bridge section documents `REA_BRIDGE_MAX_REQUEST_BYTES` and the descriptor discovery budget, but never names the directory discovery reads or the `REA_CUTTER_BRIDGE_DIR` setting that both the plugin and the client resolve. This adds one paragraph with the setting, the two default locations, the shared tilde expansion, and the fact that each process reads its own environment. Fixes #6961 ## Problem and expected behavior A reader of the Cutter bridge section cannot learn where discovery looks for session descriptors or how to point the plugin and the client at the same directory. The expected content is a short statement of the setting and its defaults, consistent with `bridge/cutter/rea_bridge.py` (`_bridge_directory`) and `src/cutter/CutterBridgeClient.ts` (`resolveBridgeDirectory`). ## Change and scope - `docs/reverse-engineering-tools.md`: one paragraph after the discovery and deadline limits in the Cutter bridge section. Documentation only; no code, schema, or generated metadata changes. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Unresolved scope, authority, side effects, or required verification block integration. Link the required maintainer scope decision for new providers or capabilities involving target execution, injection, mutation, or protection recovery; ordinary fixes within existing boundaries may state "not applicable". Draft PRs may leave the scope decision pending and the readiness and merge checklists unchecked. Maintainers can help resolve open questions. ## Contract and boundary impact - Semantic owner and earliest changed stage: the Cutter bridge documentation; no runtime stage changes. - Contribution scope fit and linked maintainer decision: not applicable (documentation of existing behavior). - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none; the text describes the current plugin and client behavior at `1d896e03b`. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none. Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none; documentation only. - Base reproduction or other evidence: source-derived. `bridge/cutter/rea_bridge.py` lines 451 to 457 and `src/cutter/CutterBridgeClient.ts` lines 1170 to 1184 read the variable with the same defaults and tilde handling; `rg REA_CUTTER_BRIDGE_DIR docs README.md` at `1d896e03b` returns nothing. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: none beyond the rendered-page check CI performs. For evidence-bearing changes: - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. Not an evidence-bearing change. ## Validation performed - No commands were run locally. The documentation checks in the repository CI on this PR are the executed validation. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none; the paragraph names default cache locations already present in source. ## Author readiness Human owner: @viniciusdsandrade - [x] 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. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] 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. - [ ] Tests cover changed observable behavior and meaningful failure paths. (Documentation only; no observable behavior changed.) - [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:07 +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#7477
No description provided.