[PR #1422] [MERGED] docs: correct host requirements in the README analysis tables #2874

Closed
opened 2026-10-17 21:11:16 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1422
Author: @Fazmin
Created: 10/10/2026
Status: ✅ Merged
Merged: 10/10/2026
Merged by: @morluto

Base: main ← Head: docs/readme-platform-requirements


📝 Commits (1)

  • 2fc5317 docs: correct host requirements in the README analysis tables

📊 Changes

17 files changed (+61 additions, -61 deletions)

View changed files

📝 README.md (+2 -2)
📝 README_ar.md (+3 -3)
📝 README_de.md (+3 -3)
📝 README_es.md (+3 -3)
📝 README_fa.md (+3 -3)
📝 README_fr.md (+3 -3)
📝 README_ja.md (+3 -3)
📝 README_ko.md (+3 -3)
📝 README_pl.md (+3 -3)
📝 README_pt-BR.md (+3 -3)
📝 README_ru.md (+3 -3)
📝 README_th.md (+3 -3)
📝 README_tr.md (+3 -3)
📝 README_uk.md (+14 -14)
📝 README_vi.md (+3 -3)
📝 README_zh-TW.md (+3 -3)
📝 README_zh.md (+3 -3)

📄 Description

Summary

The "What you can analyze" tables in README.md and its 16 translations state host requirements that don't match the code:

  1. EVM bytecode and recorded crashes (all 17 READMEs): the table doesn't say these need a Linux x64 host. On any other host both commands refuse with capability_unavailable.
  2. Android APKs (16 translations): the translations say Linux/macOS. Windows x64 has been supported since 6.2.0, but #1276 updated only the English table.

No issue is linked because these are small factual corrections.

Problem and expected behavior

  • EVM: src/evm/EvmoleInterfaceProvider.ts refuses with capability_unavailable when process.platform !== "linux" || process.arch !== "x64". On macOS, rea inspect-evm-interface x.hex hex --json reports "Initial real-verified offline EVM interface profile supports Linux x64 only." The README cell said only "Local raw/hex carrier".
  • Recorded crashes: src/native/pwntools/PwntoolsDecoder.ts has the same host check. The README cell said only "Caller-supplied pwntools", while the neighbouring Offline ELF layout row, which uses the same decoder, already says "Caller-supplied pwntools on Linux x64".
  • Android (translations): README.md says "Headless JADX and a full JDK on Linux/macOS/Windows x64", added by 636b245f (#1276, shipped in 6.2.0), and docs/android-analysis.md documents the Windows x64 boundary. Every translation still said Linux/macOS.

Change and scope

  • README.md: append "on Linux x64" to the EVM and recorded-crash requirement cells, matching the Offline ELF layout row's wording.
  • Translations: the same two cells plus the Android cell. No new prose is translated; every edit reuses wording the same file already contains:
    • The recorded-crash cell copies that file's ELF-row phrase ("…pwntools … Linux x64") verbatim.
    • The EVM cell adds "on Linux x64" using the construction the file already uses for host platforms. For example, Linux x64 上的… (zh/zh-TW/ja), Linux x64의 … (ko) and … unter Linux x64 (de).
    • The Android cell changes Linux/macOS to Linux/macOS/Windows x64. In Polish, "w systemie" becomes plural "w systemach".
  • Formatting: oxfmt re-padded the whole Ukrainian table because its recorded-crash cell became the column's widest. Every other file changes only the edited rows.

Native-speaker review of the translated cells is welcome. Other translation drift, such as the intro's provider list and the newer disclaimer paragraph, is out of scope for this PR.

Contract and boundary impact

  • Semantic owner and earliest changed stage: README documentation only
  • CLI and MCP/tool-catalog contract: none
  • Provider, bridge, target-format, or platform compatibility: documentation now matches existing host checks; no behavior change
  • Evidence, artifact, provenance, or reconstruction contract: none
  • Process execution, authorization, cleanup, or containment impact: none
  • Generated metadata, package, or installation impact: none

Evidence and regression coverage

  • Tests added or updated: none; this PR changes documentation only. The existing README guards still pass.
  • Base reproduction / evidence: on macOS (arm64), rea inspect-evm-interface and rea inspect-recorded-crash both return capability_unavailable with "…supports Linux x64 only." The host checks are at the source lines cited above.
  • Remaining proof gaps: I did not run Linux x64 EVM or crash analysis for this docs-only change.

Validation performed

All commands ran on macOS (arm64) with Node 24.18.0:

  • npm run test:focused -- tests/conformance/readmeConsistency.test.ts: 2 passed.
  • npm run check: passed, including format:check.
  • npm run docs:check: passed, including the README link-target parity check.

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

Review checklist

  • This PR addresses a concrete problem or an agreed enhancement.
  • 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/1422 **Author:** [@Fazmin](https://github.com/Fazmin) **Created:** 10/10/2026 **Status:** ✅ Merged **Merged:** 10/10/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docs/readme-platform-requirements` --- ### 📝 Commits (1) - [`2fc5317`](https://github.com/morluto/rea/commit/2fc53179b70cee763206b4889a28b6b6c66d95e0) docs: correct host requirements in the README analysis tables ### 📊 Changes **17 files changed** (+61 additions, -61 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+2 -2) 📝 `README_ar.md` (+3 -3) 📝 `README_de.md` (+3 -3) 📝 `README_es.md` (+3 -3) 📝 `README_fa.md` (+3 -3) 📝 `README_fr.md` (+3 -3) 📝 `README_ja.md` (+3 -3) 📝 `README_ko.md` (+3 -3) 📝 `README_pl.md` (+3 -3) 📝 `README_pt-BR.md` (+3 -3) 📝 `README_ru.md` (+3 -3) 📝 `README_th.md` (+3 -3) 📝 `README_tr.md` (+3 -3) 📝 `README_uk.md` (+14 -14) 📝 `README_vi.md` (+3 -3) 📝 `README_zh-TW.md` (+3 -3) 📝 `README_zh.md` (+3 -3) </details> ### 📄 Description ## Summary The "What you can analyze" tables in `README.md` and its 16 translations state host requirements that don't match the code: 1. **EVM bytecode and recorded crashes (all 17 READMEs):** the table doesn't say these need a Linux x64 host. On any other host both commands refuse with `capability_unavailable`. 2. **Android APKs (16 translations):** the translations say Linux/macOS. Windows x64 has been supported since 6.2.0, but #1276 updated only the English table. No issue is linked because these are small factual corrections. ## Problem and expected behavior - **EVM:** `src/evm/EvmoleInterfaceProvider.ts` refuses with `capability_unavailable` when `process.platform !== "linux" || process.arch !== "x64"`. On macOS, `rea inspect-evm-interface x.hex hex --json` reports "Initial real-verified offline EVM interface profile supports Linux x64 only." The README cell said only "Local raw/hex carrier". - **Recorded crashes:** `src/native/pwntools/PwntoolsDecoder.ts` has the same host check. The README cell said only "Caller-supplied pwntools", while the neighbouring Offline ELF layout row, which uses the same decoder, already says "Caller-supplied pwntools on Linux x64". - **Android (translations):** `README.md` says "Headless JADX and a full JDK on Linux/macOS/Windows x64", added by 636b245f (#1276, shipped in 6.2.0), and `docs/android-analysis.md` documents the Windows x64 boundary. Every translation still said `Linux/macOS`. ## Change and scope - **`README.md`:** append "on Linux x64" to the EVM and recorded-crash requirement cells, matching the Offline ELF layout row's wording. - **Translations:** the same two cells plus the Android cell. No new prose is translated; every edit reuses wording the same file already contains: - The recorded-crash cell copies that file's ELF-row phrase ("…pwntools … Linux x64") verbatim. - The EVM cell adds "on Linux x64" using the construction the file already uses for host platforms. For example, `Linux x64 上的…` (zh/zh-TW/ja), `Linux x64의 …` (ko) and `… unter Linux x64` (de). - The Android cell changes `Linux/macOS` to `Linux/macOS/Windows x64`. In Polish, "w systemie" becomes plural "w systemach". - **Formatting:** `oxfmt` re-padded the whole Ukrainian table because its recorded-crash cell became the column's widest. Every other file changes only the edited rows. Native-speaker review of the translated cells is welcome. Other translation drift, such as the intro's provider list and the newer disclaimer paragraph, is out of scope for this PR. ## Contract and boundary impact - Semantic owner and earliest changed stage: README documentation only - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: documentation now matches existing host checks; no behavior change - Evidence, artifact, provenance, or reconstruction contract: none - Process execution, authorization, cleanup, or containment impact: none - Generated metadata, package, or installation impact: none ## Evidence and regression coverage - **Tests added or updated:** none; this PR changes documentation only. The existing README guards still pass. - **Base reproduction / evidence:** on macOS (arm64), `rea inspect-evm-interface` and `rea inspect-recorded-crash` both return `capability_unavailable` with "…supports Linux x64 only." The host checks are at the source lines cited above. - **Remaining proof gaps:** I did not run Linux x64 EVM or crash analysis for this docs-only change. ## Validation performed All commands ran on macOS (arm64) with Node 24.18.0: - `npm run test:focused -- tests/conformance/readmeConsistency.test.ts`: 2 passed. - `npm run check`: passed, including `format:check`. - `npm run docs:check`: passed, including the README link-target parity check. ## 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 ## Review checklist - [x] This PR addresses a concrete problem or an agreed enhancement. - [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. 🤖 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-17 21:11:16 +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#2874
No description provided.