Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
saleyn committed Aug 31, 2024
1 parent 66b0049 commit 4ad66d6
Show file tree
Hide file tree
Showing 3 changed files with 371 additions and 389 deletions.
49 changes: 25 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,30 +135,31 @@ The program is distributed under BSD license.
Copyright (c) 2003 Serge Aleynikov

## Architecture
```
┌───────────────────────────┐
│ ┌────┐ ┌────┐ ┌────┐ │
│ │Pid1│ │Pid2│ │PidN│ │ Erlang light-weight Pids associated
│ └────┘ └────┘ └────┘ │ one-to-one with managed OsPids
│ ╲ │ ╱ │
│ ╲ │ ╱ │
│ ╲ │ ╱ (links) │
│ ┌──────┐ │
│ │ exec │ │ Exec application running in Erlang VM
│ └──────┘ │
│ Erlang VM │ │
└─────────────┼─────────────┘
┌───────────┐
│ exec-port │ Port program (separate OS process)
└───────────┘
╱ │ ╲
(optional stdin/stdout/stderr pipes)
╱ │ ╲
┌──────┐ ┌──────┐ ┌──────┐
│OsPid1│ │OsPid2│ │OsPidN│ Managed Child OS processes
└──────┘ └──────┘ └──────┘
```

<pre>
┌───────────────────────────┐
│ ┌────┐ ┌────┐ ┌────┐ │
│ │Pid1│ │Pid2│ │PidN│ │ Erlang light-weight Pids associated
│ └────┘ └────┘ └────┘ │ one-to-one with managed OsPids
│ ╲ │ ╱ │
│ ╲ │ ╱ │
│ ╲ │ ╱ (links) │
│ ┌──────┐ │
│ │ exec │ │ Exec application running in Erlang VM
│ └──────┘ │
│ Erlang VM │ │
└─────────────┼─────────────┘
┌───────────┐
│ exec-port │ Port program (separate OS process)
└───────────┘
╱ │ ╲
(optional stdin/stdout/stderr pipes)
╱ │ ╲
┌──────┐ ┌──────┐ ┌──────┐
│OsPid1│ │OsPid2│ │OsPidN│ Managed Child OS processes
└──────┘ └──────┘ └──────┘
</pre>

## Configuration Options

Expand Down
4 changes: 1 addition & 3 deletions rebar.config
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@
{"(linux|darwin|solaris)", clean, "make -C c_src clean"}
]}.

{plugins, [rebar3_hex, rebar3_ex_doc]}.

{plugins, [rebar3_hex, {rebar3_ex_doc, "0.2.12"}]}.
{hex, [{doc, ex_doc}]}.

{ex_doc, [
Expand All @@ -23,6 +22,5 @@
{"LICENSE", #{title => "License"}}
]},
{main, "README.md"},
{authors, ["Serge Aleynikov"]},
{source_url, "https://github.com/saleyn/erlexec"}
]}.
Loading

0 comments on commit 4ad66d6

Please sign in to comment.