docs(ssh): name SSH_MUX_ORPHAN_REAP_ENABLED in mux cleanup docblocks

The docblocks for reapOrphan and removeMultiplexFile now name
SSH_MUX_ORPHAN_REAP_ENABLED as the flag behind the dry-run default.
Operators can see which setting turns on real reaping.
This commit is contained in:
Andras Bacsai
2026-10-15 23:06:41 +02:00
parent 4294856685
commit bc3ff14567
@@ -154,9 +154,10 @@ class CleanupStaleMultiplexedConnections implements ShouldQueue
}
/**
* Reap a detected orphan process. When orphan reaping is disabled (the
* default), the orphan is only logged — a dry-run mode that lets operators
* verify what would be killed before enabling it for real.
* Reap a detected orphan process. When orphan reaping is disabled
* (SSH_MUX_ORPHAN_REAP_ENABLED=false, the default), the orphan is only
* logged — a dry-run mode that lets operators verify what would be killed
* before enabling it for real.
*
* @param array{pid: string, ppid: string, etimes: int, args: string} $process
*/
@@ -255,8 +256,9 @@ class CleanupStaleMultiplexedConnections implements ShouldQueue
/**
* Close and delete a stale mux socket file. When orphan reaping is disabled
* (the default), the file is only logged — a dry-run mode that lets operators
* verify what would be removed before enabling it for real.
* (SSH_MUX_ORPHAN_REAP_ENABLED=false, the default), the file is only logged —
* a dry-run mode that lets operators verify what would be removed before
* enabling it for real.
*/
private function removeMultiplexFile(string $muxFile, string $reason): void
{