Skip to content

Commit

Permalink
Add README.md to maelstrom-worker-child.
Browse files Browse the repository at this point in the history
  • Loading branch information
nfachan committed Jan 23, 2024
1 parent b926a38 commit 0fcf021
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion crates/maelstrom-worker-child/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "maelstrom-worker-child"
description = "No_std worker code that is run in the child process"
description = "No_std worker code that is run in the child process."
documentation.workspace = true
edition.workspace = true
homepage.workspace = true
Expand Down
11 changes: 11 additions & 0 deletions crates/maelstrom-worker-child/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Maelstrom Worker Child

This is a small library that is only intended to be used by the
[maelstrom-worker](../maelstrom-worker). It is its own library so it can
be `no_std` and we can ensure that it doesn't take any undesired dependencies.

This library is instended to be used in the child processes after a `clone`
syscall in potentially-multithreaded processes. The child process in this case
is very limited in what it can do without potentially blocking. For example,
even allocations are disallowed. This library just executes a series of
syscalls, the last of which should be `execve`.

0 comments on commit 0fcf021

Please sign in to comment.