summaryrefslogtreecommitdiff
path: root/corebinutils/sh/README.md
blob: 65abe8f50fa0e69f47cec45bc888f901ba446fd4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# sh

Standalone Linux-native port of FreeBSD `sh` for Project Tick BSD/Linux Distribution, with in-tree `libedit`, `vis`, and a local ANSI/termcap backend for history and line editing.

## Build

```sh
gmake -f GNUmakefile
gmake -f GNUmakefile CC=musl-gcc
```

Binary output:

```sh
out/sh
```

## Test

```sh
gmake -f GNUmakefile test
gmake -f GNUmakefile test CC=musl-gcc
```

## Port Strategy

- The FreeBSD `bsd.prog.mk` build is replaced with a standalone `GNUmakefile` that regenerates `builtins.c`, `builtins.h`, `nodes.c`, `nodes.h`, `syntax.c`, `syntax.h`, and `token.h`.
- No shared BSD compatibility shim is introduced. FreeBSD-only assumptions are either rewritten directly for Linux or rejected with explicit runtime errors.
- History and editline support are built from the repository's `contrib/libedit` sources rather than depending on a host `libedit` package.
- Terminal capability handling is provided by a local Linux-oriented ANSI/termcap implementation, avoiding host `ncurses`/`tinfo` ABI dependencies and keeping musl builds runnable.
- `wait3(2)` is replaced with Linux `wait4(-1, ...)` for job accounting and child collection.
- `CLOCK_UPTIME`-based `read -t` timing is mapped to `CLOCK_MONOTONIC`, preserving monotonic timeout behavior on Linux.
- BSD `sys_signame` / `sys_nsig` usage is replaced with a local Linux signal table that covers standard signals plus `SIGRTMIN`/`SIGRTMAX`.
- Symbolic `umask` parsing uses the local mode compiler carried from the sibling `bin/chmod` port rather than BSD `setmode(3)` / `getmode(3)`.
- ENOEXEC fallback uses the running shell image from `/proc/self/exe` when available so Linux tests exercise the ported shell rather than the host `/bin/sh`.
- Long-directory `pwd` recovery uses logical `PWD` tracking for `cd -L` and a `/proc/self/cwd` fallback for physical lookups when `getcwd(3)` cannot report the path on Linux.
- The test harness resets inherited `SIGPIPE` disposition before spawning the shell so trap and pipeline tests stay deterministic under CI, PTYs, and container runtimes.

## Supported / Unsupported Linux Semantics

- Supported: POSIX shell scripts, pipelines, expansions, traps, job control, `wait`, `kill %job`, `command -p`, symbolic `umask`, and interactive prompting.
- Supported: interactive history, `fc`, and editline bindings through vendored `libedit`.
- Supported with Linux-native mapping: interactive editing targets ANSI/xterm-style terminals through the local termcap backend instead of relying on external `ncurses`/`termcap` libraries.
- Supported with Linux-native mapping: `read -t` uses monotonic time, job waiting uses `wait4(2)`, and shell self-reexec falls back through `/proc/self/exe`.
- Unsupported: `set -o verify` / `set +o verify` enabling is rejected with an explicit error because Linux has no `O_VERIFY` equivalent.
- Unsupported: non-ANSI terminal databases are not consulted. Exotic `TERM` entries outside the built-in ANSI capability set may lose advanced editing behavior even though non-interactive shell semantics remain supported.