aw 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53c2d18a8428abd23fba9b9f1860a0dbeb534186d30688fd62f688b4993cba6e
-  data.tar.gz: b1b0827cda24deccdfd965fbd961ff32f1026faaa7def260effd1f8f68877f65
+  metadata.gz: 9b3e173f5eb48d67ae27b75d5d59330b8483119700ac8f9215eaf1f2ab2c7980
+  data.tar.gz: d8249389baeeeacffaefe74222a1686e2d311d32292df8e9b2665ba68c2d34a4
 SHA512:
-  metadata.gz: 4c0062da308b75ca108e7189534249d04fa127524947ae090fb170a396b8bbe2a6ffe1e327c7dd9a99c68ba33f9f88ac2105b98e8161b14b1425ba6f37b8cc82
-  data.tar.gz: 26efdd7a730e0e8c1c66f61bd1db84f65a7c23e2f438165d0d99577f2801815d8967243ac45bc43163508101329c6dd6e05afec5534571ba13fb7ba5f29be6f9
+  metadata.gz: 48aadec08cd55c084eb66e894ec0189e8fdcab084bcf33b6cba4d42cd739af2045561f05fc14a1463be2593a648ba3fc49514bcd262ee20ef010441668ba22b4
+  data.tar.gz: 942922f6a3b48f6027f4269378bbab2ba7c81dea9a9e76555b587d00e7f952f265be27e41d3eaf9ddb14bededb21f29cbfbf6f6a9c6a903c867ece7c197e0188

data/README.md

@@ -8,7 +8,7 @@
 
 ![A pixel-art hero shouting "Aw, fork!" while his forked clone strikes a golem](https://github.com/fixrb/aw/raw/main/img/aw.png)
 
-Runs a block in a forked child process and brings back what it returned, or re-raises what it raised. What the block does to the process stays in the child; what it does outside, to files or to other processes, does not.
+Runs a block in a forked child process and brings back what it returned, or re-raises what it raised. What the block does to the process stays in the child; what it does outside, to files or to other processes, happens.
 
 ## Installation
 
@@ -17,7 +17,7 @@ Runs a block in a forked child process and brings back what it returned, or re-r
 gem "aw"
 ```
 
-Aw requires Ruby 3.3 or later and `fork(2)`: it runs on Linux, macOS and the BSDs with CRuby, and declines elsewhere (Windows, JRuby) with a `NotImplementedError`. `Aw.supported?` tells beforehand.
+Aw requires Ruby 3.3 or later and `fork(2)`: it is tested with CRuby on Linux and macOS, and declines where `fork` is missing (Windows, JRuby) with a `NotImplementedError`. `Aw.supported?` tells beforehand.
 
 ## Usage
 
@@ -78,7 +78,7 @@ The value that comes back is a copy: an object returns as a new object, and its
 - Aw has no timeout of its own: `fork!` and `fork?` wait until the child exits, whatever keeps it alive (a block that loops or sleeps, a child stopped by `SIGSTOP`, a standard stream whose `flush` blocks, a thread that goes on after the result was written). Wrap code you do not trust in a `Timeout` of your own.
 - If the parent is interrupted while waiting (`Interrupt`, `Timeout`, `Thread#kill`), the child is asked to leave with `TERM`, killed with `KILL` if it is still there half a second later, and reaped, before the interruption proceeds, with no window between the fork and that guard. A second interruption during the reaping waits for it: no zombie is left.
 - No file descriptor is left open after a call.
-- Forks can be nested. The `TERM` an interrupted parent sends to an outer fork reaches it as a `SignalException`, which lets it ask its own children to leave and reap them in turn; only an outer fork that ignores `TERM` leaves them orphaned when it is killed.
+- Forks can be nested. The `TERM` an interrupted parent sends to an outer fork reaches it as a `SignalException`, which lets it ask its own children to leave and reap them in turn, within the same half second. A fork that ignores `TERM` leaves orphans: the children of an outer one, when it is killed, and an inner one itself, as the fork above it is likely to be killed before it can kill it.
 - A fork costs a few milliseconds; the pages of the parent are shared copy-on-write, and the cost grows with the size of the parent (about 2 ms at 50 MB, 20 ms at 700 MB).
 
 ## Things to know about fork
@@ -92,6 +92,10 @@ The value that comes back is a copy: an object returns as a new object, and its
 - SimpleCov stores the coverage of a process from an `at_exit` handler, which `exit!` skips: the code the child runs is not in the parent's report. With `merge_subprocesses true` (`enable_for_subprocesses true` before SimpleCov 1.3), call `SimpleCov.result` in an `ensure` of the block to store the child's share; the parent merges it.
 - The parent deserializes, with `Marshal`, what the child wrote; the child ran your block, which could reach the pipe and write anything. Aw isolates the side effects of code you trust; it is not a sandbox for code you do not. A hostile block can make `fork!` return or raise anything, make `fork?` answer `true`, choose the message of an `Aw::ChildError`, make the parent hold as much memory as it writes, run the parent's `marshal_load` methods and autoloads, and, from a continuation the parent captured (`callcc`), run the parent's code in the child: only the `status` of an `Aw::ChildError` comes from the system. Running as the parent's user, it can also signal the parent and leave processes behind; Aw kills and reaps the child only.
 
+## Changes in 1.0.2
+
+- Documentation: a fork that ignores `TERM` leaves orphans whether it is an outer one or an inner one, where 1.0.1 said so of an outer one only; Aw is tested on Linux and macOS, the BSDs no longer being named; what the block does outside the process happens.
+
 ## Changes in 1.0.1
 
 - A process the block forked without a block, and which let the block return, no longer delivers a result in place of the child: it leaves without writing, as the child alone writes.

data/lib/aw.rb

@@ -7,7 +7,7 @@ require_relative "aw/fork"
 # or re-raises what it raised. Side effects of the block on the process
 # (mutations, globals, constants, the current directory, `ENV`, a crash)
 # stay in the child; what it does outside, to files or to other processes,
-# does not.
+# happens.
 #
 # The result travels through a pipe with `Marshal`, so it must be a
 # marshalable value; a `Proc`, an `IO` or an instance of an anonymous class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aw
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Cyril Kato
@@ -26,6 +26,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/fixrb/aw/issues
+  changelog_uri: https://github.com/fixrb/aw#changes-in-102
   documentation_uri: https://rubydoc.info/gems/aw
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/fixrb/aw