[PR #3107] [CLOSED] docs(cli): clarify handled cancellation exit statuses #5622

New issue

Closed

opened 2026-10-31 01:08:03 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:08:03 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3107
Author: @geekwolf
Created: 10/14/2026
Status: ❌ Closed

Base: main ← Head: fix/cli-cancellation-exit-status

📝 Commits (2)

fa52bdf docs(cli): clarify handled cancellation exit statuses
f7de34b docs(cli): qualify cancellation results and cleanup details

📊 Changes

1 file changed (+10 additions, -1 deletions)

View changed files

📝 docs/cli.md (+10 -1)

📄 Description

Upstream integration update — 2026-10-16: the maintainer confirmed in https://github.com/morluto/rea/pull/3107#issuecomment-6182387544 that main covers this in 7d885d632c. Inspection of docs/cli.md on main 808339f0b1 confirms the signal-derived status table and command-specific cancellation caveats. No duplicate documentation push is proposed. This PR remains open and was not merged through GitHub. The original proposal and historical validation follow.

Handled signals can return 130/143 alongside a structured result, but early ASAR cancellation can report execution_failure instead of cancelled. The exit-status table now describes operation settlement without guaranteeing an error code or cleanup report. The concrete command-specific examples apply only when the returned result actually reports code: "cancelled": JavaScript analysis returns 130/143, while inspect-artifact returns 1.

Readers are directed to inspect the actual result code and any returned cleanup details. This preserves the useful exit-status clarification without extending it beyond the verified cases.

Fixes #3053.

Validation: checked against the signal-status owner, error projection and existing directory cancellation assertions. npm run docs:check passed on Node 24.18.0 / npm 11.16.0, including five README consistency tests; changed-file formatting and git diff --check passed. The maintainer's Linux ASAR counterexample informed the conditional wording; real POSIX signal scenarios were not rerun on this Windows host. Documentation only; no signal handling or exit-code changes.

Rebased onto main 767fe0f0ccbab3ae4be28e71cc8214c7cd302133; the documentation fix and its review correction are unchanged. Fresh documentation checks, all five consistency tests, scoped formatting and git diff --check passed on the pinned toolchain. The previous revision's CI was green; the rebased revision requires its own checks and maintainer re-review.

_{🔄 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/3107 **Author:** [@geekwolf](https://github.com/geekwolf) **Created:** 10/14/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `fix/cli-cancellation-exit-status` --- ### 📝 Commits (2) - [`fa52bdf`](https://github.com/morluto/rea/commit/fa52bdf5916990d4e21ff1e2b26ee397f026dff9) docs(cli): clarify handled cancellation exit statuses - [`f7de34b`](https://github.com/morluto/rea/commit/f7de34b1e33e5bb5abf59478e35d38843170d389) docs(cli): qualify cancellation results and cleanup details ### 📊 Changes **1 file changed** (+10 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `docs/cli.md` (+10 -1) </details> ### 📄 Description Upstream integration update — 2026-10-16: the maintainer confirmed in https://github.com/morluto/rea/pull/3107#issuecomment-6182387544 that main covers this in 7d885d632c226f493c435c899c2465b288bb64e8. Inspection of docs/cli.md on main 808339f0b1cf3837445f392b5d5f1f362d64a27d confirms the signal-derived status table and command-specific cancellation caveats. No duplicate documentation push is proposed. This PR remains open and was not merged through GitHub. The original proposal and historical validation follow. --- Handled signals can return 130/143 alongside a structured result, but early ASAR cancellation can report `execution_failure` instead of `cancelled`. The exit-status table now describes operation settlement without guaranteeing an error code or cleanup report. The concrete command-specific examples apply only when the returned result actually reports `code: "cancelled"`: JavaScript analysis returns 130/143, while `inspect-artifact` returns 1. Readers are directed to inspect the actual result code and any returned cleanup details. This preserves the useful exit-status clarification without extending it beyond the verified cases. Fixes #3053. Validation: checked against the signal-status owner, error projection and existing directory cancellation assertions. `npm run docs:check` passed on Node 24.18.0 / npm 11.16.0, including five README consistency tests; changed-file formatting and `git diff --check` passed. The maintainer's Linux ASAR counterexample informed the conditional wording; real POSIX signal scenarios were not rerun on this Windows host. Documentation only; no signal handling or exit-code changes. Rebased onto main `767fe0f0ccbab3ae4be28e71cc8214c7cd302133`; the documentation fix and its review correction are unchanged. Fresh documentation checks, all five consistency tests, scoped formatting and `git diff --check` passed on the pinned toolchain. The previous revision's CI was green; the rebased revision requires its own checks and maintainer re-review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:08:03 +00:00