Docs Update

This commit is contained in:
Raven Scott
2026-04-03 23:11:37 -04:00
parent f42f50eb73
commit 184b7fe3b1
32 changed files with 1098 additions and 1103 deletions
+2 -2
View File
@@ -57,7 +57,7 @@ node index.js
| `BARE_OS_FISH` | Set `0` to disable fish-style editor |
| `HYPERSWARM_BOOTSTRAP` | Optional comma-separated bootstrap nodes (HDMS / replication) |
**Copied from host into the guest session when set** (non-exhaustive; see [DOCUMENTATION.md](../../DOCUMENTATION.md) §14 and [CHANGELOG.md](./CHANGELOG.md)): `BARE_OS_PIPELINE_MAX_STAGES`, `BARE_OS_PIPELINE_MAX_BYTES`, `BARE_OS_PIPELINE_MAX_LINES`, `BARE_OS_BOOT_PROFILE`, `BARE_OS_ONBOOT`, `BARE_OS_BOOT_STRICT`, `BARE_OS_RC_D_SKIP`, `BARE_OS_BOOT_MINIMAL`, `BARE_OS_BOOT_SKIP`, `BARE_OS_BOOT_TRACE`, `BARE_OS_KERNEL_SELFTEST`, `BARE_OS_SELFTEST_FORMAT`, `BARE_OS_AUDIT`, `BARE_OS_AUDIT_JSON`, `BARE_OS_AUDIT_REDACT`, `BARE_OS_BOOT_ALLOWLIST`, `BARE_OS_EXEC_MAX_DEPTH`, `BARE_OS_IPC_MAX_BYTES`, `BARE_OS_IPC_RPC_TOKEN`, `BARE_OS_IPC_FANOUT`, `BARE_OS_IPC_JSON_MAX_BYTES`, `BARE_OS_HTTP_ALLOWLIST`, `BARE_OS_HTTP_DENYLIST`, `BARE_OS_TLS_PIN_SHA256`, `BARE_OS_VFS_WATCH`, `BARE_OS_IMAGE_DIGEST`, `BARE_OS_PEAR_CHANNEL`, `BARE_OS_PEAR_RELEASE`, `BARE_OS_BARE_MODULES`, `BARE_OS_BARE_DRIVE_BUNDLES`, `TERM`, `COLORTERM`, `PEAR_CHANNEL`.
**Copied from host into the guest session when set** (non-exhaustive; see [environment variables reference](../../docs/reference/environment-and-posix-appendix.md#14-environment-variables-complete-list) and [CHANGELOG.md](./CHANGELOG.md)): `BARE_OS_PIPELINE_MAX_STAGES`, `BARE_OS_PIPELINE_MAX_BYTES`, `BARE_OS_PIPELINE_MAX_LINES`, `BARE_OS_BOOT_PROFILE`, `BARE_OS_ONBOOT`, `BARE_OS_BOOT_STRICT`, `BARE_OS_RC_D_SKIP`, `BARE_OS_BOOT_MINIMAL`, `BARE_OS_BOOT_SKIP`, `BARE_OS_BOOT_TRACE`, `BARE_OS_KERNEL_SELFTEST`, `BARE_OS_SELFTEST_FORMAT`, `BARE_OS_AUDIT`, `BARE_OS_AUDIT_JSON`, `BARE_OS_AUDIT_REDACT`, `BARE_OS_BOOT_ALLOWLIST`, `BARE_OS_EXEC_MAX_DEPTH`, `BARE_OS_IPC_MAX_BYTES`, `BARE_OS_IPC_RPC_TOKEN`, `BARE_OS_IPC_FANOUT`, `BARE_OS_IPC_JSON_MAX_BYTES`, `BARE_OS_HTTP_ALLOWLIST`, `BARE_OS_HTTP_DENYLIST`, `BARE_OS_TLS_PIN_SHA256`, `BARE_OS_VFS_WATCH`, `BARE_OS_IMAGE_DIGEST`, `BARE_OS_PEAR_CHANNEL`, `BARE_OS_PEAR_RELEASE`, `BARE_OS_BARE_MODULES`, `BARE_OS_BARE_DRIVE_BUNDLES`, `TERM`, `COLORTERM`, `PEAR_CHANNEL`.
## Tests
@@ -76,4 +76,4 @@ npm test -w bare-os-booter
- [Developer guide — Bare modules](../../developer-guide/12-bare-modules-and-pear-ecosystem.md)
- [Handbook — Booter runtime](../../handbook/04-the-booter-runtime.md)
- [DOCUMENTATION.md](../../DOCUMENTATION.md) §12 — **`packages/bare-os-coreutils/lib/commands.mjs`** is the authoritative **`/bin`** name list
- [Booter reference](../../docs/reference/package-bare-os-booter.md) §12 — **`packages/bare-os-coreutils/lib/commands.mjs`** is the authoritative **`/bin`** name list
+1 -1
View File
@@ -56,4 +56,4 @@ See [handbook §6 — Kernel and `/bin`](../../handbook/06-kernel-and-binaries.m
## See also
- [kernel/README.md](../../kernel/README.md) — where built artifacts live in the source tree.
- [DOCUMENTATION.md](../../DOCUMENTATION.md) §12.10 (may lag the command list; **`lib/commands.mjs`** is authoritative).
- [Coreutils build reference](../../docs/reference/package-bare-os-coreutils-and-ci.md#1210-package-bare-os-coreutils) (may lag the command list; **`lib/commands.mjs`** is authoritative).
@@ -24,7 +24,7 @@
"BARE_OS_SPLIT_MAX_FILES — max output files split may create",
"BARE_OS_FIND_EXEC_MAX — max find -exec/-ok invocations per run (also in table)"
],
"bareOsNotes": "Subset only; unknown names fail with exit status 1. See src/getconf.js for the name table. BARE_OS_NPROC overrides /bin/nproc when passed from the host (see DOCUMENTATION.md §14).",
"bareOsNotes": "Subset only; unknown names fail with exit status 1. See src/getconf.js for the name table. BARE_OS_NPROC overrides /bin/nproc when passed from the host (see docs/reference/environment-and-posix-appendix.md §14).",
"examples": [
{
"caption": "path length limit",
+1 -1
View File
@@ -33,5 +33,5 @@ Runs `brittle-bare` against `test.js` (topic stability, MBR roundtrip, encodings
## See also
- Repo root [README.md](../../README.md) and [DOCUMENTATION.md](../../DOCUMENTATION.md) §10.
- Repo root [README.md](../../README.md) and [protocol reference](../../docs/reference/package-bare-os-protocol.md) §10.
- [Handbook — Blueprints § protocol](../../handbook/02-blueprints.md) (high-level).
+1 -1
View File
@@ -43,4 +43,4 @@ Optional **system** image examples: **`etc/bare-os/boot.allow.example`** (copy t
- [Handbook — Kernel and userspace](../handbook/06-kernel-and-binaries.md)
- [Handbook — POSIX utilities, shell, VFS](../handbook/09-posix-utilities-shell-and-vfs.md)
- [DOCUMENTATION.md](../DOCUMENTATION.md) §9
- [Kernel image reference](../docs/reference/kernel-image.md) §9
@@ -1,12 +1,6 @@
{
"version": 1,
"bundles": [
{
"path": "/lib/bare/bundles/b4a.js",
"keys": [
"b4a"
]
},
{
"path": "/lib/bare/bundles/safetyCatch.js",
"keys": [
@@ -19,6 +13,12 @@
"hypercoreIdEncoding"
]
},
{
"path": "/lib/bare/bundles/b4a.js",
"keys": [
"b4a"
]
},
{
"path": "/lib/bare/bundles/compactEncoding.js",
"keys": [
@@ -61,42 +61,48 @@
"bareAbort"
]
},
{
"path": "/lib/bare/bundles/bareAnsiEscapes.js",
"keys": [
"bareAnsiEscapes"
]
},
{
"path": "/lib/bare/bundles/bareAbortController.js",
"keys": [
"bareAbortController"
]
},
{
"path": "/lib/bare/bundles/bareAnsiEscapes.js",
"keys": [
"bareAnsiEscapes"
]
},
{
"path": "/lib/bare/bundles/bareReadline.js",
"keys": [
"bareReadline"
]
},
{
"path": "/lib/bare/bundles/bareAddonResolve.js",
"keys": [
"bareAddonResolve"
]
},
{
"path": "/lib/bare/bundles/bareCrypto.js",
"keys": [
"bareCrypto"
]
},
{
"path": "/lib/bare/bundles/bareAddonResolve.js",
"keys": [
"bareAddonResolve"
]
},
{
"path": "/lib/bare/bundles/bareAsyncHooks.js",
"keys": [
"bareAsyncHooks"
]
},
{
"path": "/lib/bare/bundles/bareAtomics.js",
"keys": [
"bareAtomics"
]
},
{
"path": "/lib/bare/bundles/bareAppKit.js",
"keys": [
@@ -115,12 +121,6 @@
"bareAssert"
]
},
{
"path": "/lib/bare/bundles/bareAtomics.js",
"keys": [
"bareAtomics"
]
},
{
"path": "/lib/bare/bundles/fetch.js",
"keys": [
@@ -151,12 +151,6 @@
"bareBundle"
]
},
{
"path": "/lib/bare/bundles/bareBluetoothApple.js",
"keys": [
"bareBluetoothApple"
]
},
{
"path": "/lib/bare/bundles/bareBundleEvaluate.js",
"keys": [
@@ -164,15 +158,9 @@
]
},
{
"path": "/lib/bare/bundles/bareConsole.js",
"path": "/lib/bare/bundles/bareBluetoothApple.js",
"keys": [
"bareConsole"
]
},
{
"path": "/lib/bare/bundles/bareBundleId.js",
"keys": [
"bareBundleId"
"bareBluetoothApple"
]
},
{
@@ -187,6 +175,18 @@
"bareDaemon"
]
},
{
"path": "/lib/bare/bundles/bareConsole.js",
"keys": [
"bareConsole"
]
},
{
"path": "/lib/bare/bundles/bareBundleId.js",
"keys": [
"bareBundleId"
]
},
{
"path": "/lib/bare/bundles/bareChannel.js",
"keys": [
@@ -205,12 +205,6 @@
"bareDelta"
]
},
{
"path": "/lib/bare/bundles/bareDiagnosticsChannel.js",
"keys": [
"bareDiagnosticsChannel"
]
},
{
"path": "/lib/bare/bundles/bareDns.js",
"keys": [
@@ -218,9 +212,9 @@
]
},
{
"path": "/lib/bare/bundles/bareExif.js",
"path": "/lib/bare/bundles/bareDiagnosticsChannel.js",
"keys": [
"bareExif"
"bareDiagnosticsChannel"
]
},
{
@@ -229,24 +223,30 @@
"bareEnv"
]
},
{
"path": "/lib/bare/bundles/bareCov.js",
"keys": [
"bareCov"
]
},
{
"path": "/lib/bare/bundles/bareDgram.js",
"keys": [
"bareDgram"
]
},
{
"path": "/lib/bare/bundles/bareExif.js",
"keys": [
"bareExif"
]
},
{
"path": "/lib/bare/bundles/bareFfmpeg.js",
"keys": [
"bareFfmpeg"
]
},
{
"path": "/lib/bare/bundles/bareCov.js",
"keys": [
"bareCov"
]
},
{
"path": "/lib/bare/bundles/bareFfmpegEncodings.js",
"keys": [
@@ -254,9 +254,9 @@
]
},
{
"path": "/lib/bare/bundles/bareFileLogger.js",
"path": "/lib/bare/bundles/bareFormData.js",
"keys": [
"bareFileLogger"
"bareFormData"
]
},
{
@@ -272,9 +272,15 @@
]
},
{
"path": "/lib/bare/bundles/bareFormData.js",
"path": "/lib/bare/bundles/bareFileLogger.js",
"keys": [
"bareFormData"
"bareFileLogger"
]
},
{
"path": "/lib/bare/bundles/bareGtk.js",
"keys": [
"bareGtk"
]
},
{
@@ -289,12 +295,6 @@
"bareHrtime"
]
},
{
"path": "/lib/bare/bundles/bareHttpParser.js",
"keys": [
"bareHttpParser"
]
},
{
"path": "/lib/bare/bundles/bareFs.js",
"keys": [
@@ -302,15 +302,9 @@
]
},
{
"path": "/lib/bare/bundles/bareGtk.js",
"path": "/lib/bare/bundles/bareHttpParser.js",
"keys": [
"bareGtk"
]
},
{
"path": "/lib/bare/bundles/bareIco.js",
"keys": [
"bareIco"
"bareHttpParser"
]
},
{
@@ -320,9 +314,9 @@
]
},
{
"path": "/lib/bare/bundles/bareHttps.js",
"path": "/lib/bare/bundles/bareIco.js",
"keys": [
"bareHttps"
"bareIco"
]
},
{
@@ -337,6 +331,12 @@
"bareInspect"
]
},
{
"path": "/lib/bare/bundles/bareHttps.js",
"keys": [
"bareHttps"
]
},
{
"path": "/lib/bare/bundles/bareJpeg.js",
"keys": [
@@ -362,9 +362,9 @@
]
},
{
"path": "/lib/bare/bundles/bareLogger.js",
"path": "/lib/bare/bundles/bareLink.js",
"keys": [
"bareLogger"
"bareLink"
]
},
{
@@ -374,9 +374,15 @@
]
},
{
"path": "/lib/bare/bundles/bareLink.js",
"path": "/lib/bare/bundles/bareLogger.js",
"keys": [
"bareLink"
"bareLogger"
]
},
{
"path": "/lib/bare/bundles/bareModuleLexer.js",
"keys": [
"bareModuleLexer"
]
},
{
@@ -391,24 +397,12 @@
"bareModuleResolve"
]
},
{
"path": "/lib/bare/bundles/bareModuleLexer.js",
"keys": [
"bareModuleLexer"
]
},
{
"path": "/lib/bare/bundles/bareModule.js",
"keys": [
"bareModule"
]
},
{
"path": "/lib/bare/bundles/bareModuleTraverse.js",
"keys": [
"bareModuleTraverse"
]
},
{
"path": "/lib/bare/bundles/bareNdk.js",
"keys": [
@@ -416,9 +410,9 @@
]
},
{
"path": "/lib/bare/bundles/bareNodeFetch.js",
"path": "/lib/bare/bundles/bareModuleTraverse.js",
"keys": [
"bareNodeFetch"
"bareModuleTraverse"
]
},
{
@@ -428,9 +422,9 @@
]
},
{
"path": "/lib/bare/bundles/bareNet.js",
"path": "/lib/bare/bundles/bareNodeFetch.js",
"keys": [
"bareNet"
"bareNodeFetch"
]
},
{
@@ -439,6 +433,12 @@
"bareOpen"
]
},
{
"path": "/lib/bare/bundles/bareNet.js",
"keys": [
"bareNet"
]
},
{
"path": "/lib/bare/bundles/bareMedia.js",
"keys": [
@@ -457,6 +457,24 @@
"barePack"
]
},
{
"path": "/lib/bare/bundles/bareNodeRuntime.js",
"keys": [
"bareNodeRuntime"
]
},
{
"path": "/lib/bare/bundles/bareDev.js",
"keys": [
"bareDev"
]
},
{
"path": "/lib/bare/bundles/barePng.js",
"keys": [
"barePng"
]
},
{
"path": "/lib/bare/bundles/barePerformance.js",
"keys": [
@@ -469,18 +487,6 @@
"barePackDrive"
]
},
{
"path": "/lib/bare/bundles/barePng.js",
"keys": [
"barePng"
]
},
{
"path": "/lib/bare/bundles/barePipe.js",
"keys": [
"barePipe"
]
},
{
"path": "/lib/bare/bundles/barePunycode.js",
"keys": [
@@ -488,9 +494,9 @@
]
},
{
"path": "/lib/bare/bundles/bareNodeRuntime.js",
"path": "/lib/bare/bundles/bareQuerystring.js",
"keys": [
"bareNodeRuntime"
"bareQuerystring"
]
},
{
@@ -500,21 +506,9 @@
]
},
{
"path": "/lib/bare/bundles/bareDev.js",
"path": "/lib/bare/bundles/barePipe.js",
"keys": [
"bareDev"
]
},
{
"path": "/lib/bare/bundles/bareProcess.js",
"keys": [
"bareProcess"
]
},
{
"path": "/lib/bare/bundles/bareQuerystring.js",
"keys": [
"bareQuerystring"
"barePipe"
]
},
{
@@ -529,6 +523,12 @@
"bareRealm"
]
},
{
"path": "/lib/bare/bundles/bareProcess.js",
"keys": [
"bareProcess"
]
},
{
"path": "/lib/bare/bundles/barePromClient.js",
"keys": [
@@ -548,21 +548,9 @@
]
},
{
"path": "/lib/bare/bundles/bareSemver.js",
"path": "/lib/bare/bundles/bareRepl.js",
"keys": [
"bareSemver"
]
},
{
"path": "/lib/bare/bundles/bareSignals.js",
"keys": [
"bareSignals"
]
},
{
"path": "/lib/bare/bundles/bareSidecar.js",
"keys": [
"bareSidecar"
"bareRepl"
]
},
{
@@ -572,9 +560,9 @@
]
},
{
"path": "/lib/bare/bundles/bareRepl.js",
"path": "/lib/bare/bundles/bareSemver.js",
"keys": [
"bareRepl"
"bareSemver"
]
},
{
@@ -584,21 +572,15 @@
]
},
{
"path": "/lib/bare/bundles/bareStdio.js",
"path": "/lib/bare/bundles/bareSidecar.js",
"keys": [
"bareStdio"
"bareSidecar"
]
},
{
"path": "/lib/bare/bundles/bareStringDecoder.js",
"path": "/lib/bare/bundles/bareSignals.js",
"keys": [
"bareStringDecoder"
]
},
{
"path": "/lib/bare/bundles/bareStream.js",
"keys": [
"bareStream"
"bareSignals"
]
},
{
@@ -607,12 +589,36 @@
"bareStorage"
]
},
{
"path": "/lib/bare/bundles/bareStream.js",
"keys": [
"bareStream"
]
},
{
"path": "/lib/bare/bundles/bareStringDecoder.js",
"keys": [
"bareStringDecoder"
]
},
{
"path": "/lib/bare/bundles/bareStdio.js",
"keys": [
"bareStdio"
]
},
{
"path": "/lib/bare/bundles/bareSvg.js",
"keys": [
"bareSvg"
]
},
{
"path": "/lib/bare/bundles/bareSystemLogger.js",
"keys": [
"bareSystemLogger"
]
},
{
"path": "/lib/bare/bundles/bareStructuredClone.js",
"keys": [
@@ -620,9 +626,9 @@
]
},
{
"path": "/lib/bare/bundles/bareSystemLogger.js",
"path": "/lib/bare/bundles/bareTap.js",
"keys": [
"bareSystemLogger"
"bareTap"
]
},
{
@@ -638,9 +644,9 @@
]
},
{
"path": "/lib/bare/bundles/bareTap.js",
"path": "/lib/bare/bundles/bareTimers.js",
"keys": [
"bareTap"
"bareTimers"
]
},
{
@@ -649,24 +655,12 @@
"bareTcp"
]
},
{
"path": "/lib/bare/bundles/bareTimers.js",
"keys": [
"bareTimers"
]
},
{
"path": "/lib/bare/bundles/bareThread.js",
"keys": [
"bareThread"
]
},
{
"path": "/lib/bare/bundles/bareType.js",
"keys": [
"bareType"
]
},
{
"path": "/lib/bare/bundles/bareTpl.js",
"keys": [
@@ -674,21 +668,9 @@
]
},
{
"path": "/lib/bare/bundles/bareTls.js",
"path": "/lib/bare/bundles/bareType.js",
"keys": [
"bareTls"
]
},
{
"path": "/lib/bare/bundles/bareTty.js",
"keys": [
"bareTty"
]
},
{
"path": "/lib/bare/bundles/bareUnpack.js",
"keys": [
"bareUnpack"
"bareType"
]
},
{
@@ -697,24 +679,30 @@
"bareUiKit"
]
},
{
"path": "/lib/bare/bundles/bareTls.js",
"keys": [
"bareTls"
]
},
{
"path": "/lib/bare/bundles/bareUnpack.js",
"keys": [
"bareUnpack"
]
},
{
"path": "/lib/bare/bundles/bareTty.js",
"keys": [
"bareTty"
]
},
{
"path": "/lib/bare/bundles/bareV8.js",
"keys": [
"bareV8"
]
},
{
"path": "/lib/bare/bundles/bareWalkHandles.js",
"keys": [
"bareWalkHandles"
]
},
{
"path": "/lib/bare/bundles/bareUnionBundle.js",
"keys": [
"bareUnionBundle"
]
},
{
"path": "/lib/bare/bundles/bareVm.js",
"keys": [
@@ -722,9 +710,15 @@
]
},
{
"path": "/lib/bare/bundles/bareUtils.js",
"path": "/lib/bare/bundles/bareUnionBundle.js",
"keys": [
"bareUtils"
"bareUnionBundle"
]
},
{
"path": "/lib/bare/bundles/bareWalkHandles.js",
"keys": [
"bareWalkHandles"
]
},
{
@@ -733,12 +727,24 @@
"bareWebKit"
]
},
{
"path": "/lib/bare/bundles/bareWebKitGtk.js",
"keys": [
"bareWebKitGtk"
]
},
{
"path": "/lib/bare/bundles/bareWebp.js",
"keys": [
"bareWebp"
]
},
{
"path": "/lib/bare/bundles/bareUtils.js",
"keys": [
"bareUtils"
]
},
{
"path": "/lib/bare/bundles/bareWhich.js",
"keys": [
@@ -746,9 +752,9 @@
]
},
{
"path": "/lib/bare/bundles/bareWebKitGtk.js",
"path": "/lib/bare/bundles/bareV8ToIstanbul.js",
"keys": [
"bareWebKitGtk"
"bareV8ToIstanbul"
]
},
{
@@ -757,12 +763,6 @@
"bareWinUi"
]
},
{
"path": "/lib/bare/bundles/bareV8ToIstanbul.js",
"keys": [
"bareV8ToIstanbul"
]
},
{
"path": "/lib/bare/bundles/bareXdiff.js",
"keys": [
@@ -781,17 +781,17 @@
"bareWs"
]
},
{
"path": "/lib/bare/bundles/bareWorker.js",
"keys": [
"bareWorker"
]
},
{
"path": "/lib/bare/bundles/bareZmq.js",
"keys": [
"bareZmq"
]
},
{
"path": "/lib/bare/bundles/bareWorker.js",
"keys": [
"bareWorker"
]
}
],
"bundleStats": {
File diff suppressed because one or more lines are too long