MD Formatting fixes
This commit is contained in:
Raven Scott
@@ -19,27 +19,27 @@ See also [`docs/audit/PLACEHOLDER_BASELINE.md`](../docs/audit/PLACEHOLDER_BASELI
|
||||
|
||||
**Bundle refresh governance (maintainers):** after changing Holepunch pins or `kernel/lib/bare/manifest.json`, run `npm run gen:bare-catalog` (or `:check`), `npm run build -w bare-os-bare-libs`, `npm run bundle:kernel`, then `node scripts/verify-kernel-seeder-parity.mjs`. Optional: `npm run audit:holepunch-clones` and `node scripts/verify-holepunch-clone-drift.mjs` when local clones under `BARE_OS_HOLEPUNCH_CLONES_ROOT` track upstream. Release checklist runs `report-holepunch-lockfile-drift.mjs` and clone drift verification.
|
||||
|
||||
**`kernel/init.js` is generated:** run **`node scripts/bundle-kernel-init.mjs`** after editing `kernel/lib/boot/*.js` or `kernel/lib/init/init-main.js`. **`scripts/verify-kernel-seeder-parity.mjs`** checks that the file matches that recipe and that **`kernel/`** matches **`packages/bare-os-seeder/kernel/`** byte-for-byte.
|
||||
**`kernel/init.js` is generated:** run **`node scripts/bundle-kernel-init.mjs`** after editing `kernel/lib/boot/*.js` or `kernel/lib/init/init-main.js`. **`scripts/verify-kernel-seeder-parity.mjs**` checks that the file matches that recipe and that `**kernel/**` matches `**packages/bare-os-seeder/kernel/`** byte-for-byte.
|
||||
|
||||
---
|
||||
|
||||
Bare OS **guest** code (kernel `/boot/init.js`, `/bin` utilities running in the Pear/Bare host) must **not** rely on Node’s **`node:*`** built-in specifiers. Use Holepunch **`bare-*`** packages (local clones under [holepunchto](https://github.com/holepunchto)) instead. Validate `kernel/lib/bare/manifest.json` with **`kernel-manifest-validate`**; optional per-row **`dualTarget`**: `bare-only` | `dual` | `host-delegate-only` for extension policy; import-map templates live beside `package.json` on trusted images (see [kernel-program.md](./kernel-program.md)).
|
||||
Bare OS **guest** code (kernel `/boot/init.js`, `/bin` utilities running in the Pear/Bare host) must **not** rely on Node’s **`node:***` built-in specifiers. Use Holepunch `**bare-*`** packages (local clones under [holepunchto](https://github.com/holepunchto)) instead. Validate `kernel/lib/bare/manifest.json` with **`kernel-manifest-validate**`; optional per-row `**dualTarget`**: `bare-only` | `dual` | `host-delegate-only` for extension policy; import-map templates live beside `package.json` on trusted images (see [kernel-program.md](./kernel-program.md)).
|
||||
|
||||
- `node:crypto` — [`bare-crypto`](https://github.com/holepunchto/bare-crypto) — host sets **`BARE_OS_BARE_CRYPTO_VERSION`** for boot policy **`requireBareCryptoMin`**.
|
||||
- `node:crypto` — [`bare-crypto`](https://github.com/holepunchto/bare-crypto) — host sets **`BARE_OS_BARE_CRYPTO_VERSION**` for boot policy `**requireBareCryptoMin`**.
|
||||
- `node:module` / `createRequire` — [`bare-module`](https://github.com/holepunchto/bare-module), [`bare-module-resolve`](https://github.com/holepunchto/bare-module-resolve) — boot policy may list **`denyBareModuleSpecifierPatterns`**.
|
||||
- `node:fs` — [`bare-fs`](https://github.com/holepunchto/bare-fs) — guest uses **`ctx.vfs`** for the image.
|
||||
- `node:path` — [`bare-path`](https://github.com/holepunchto/bare-path)
|
||||
- `node:url` — [`bare-url`](https://github.com/holepunchto/bare-url)
|
||||
- `node:net` / `node:tls` — [`bare-net`](https://github.com/holepunchto/bare-net), [`bare-tls`](https://github.com/holepunchto/bare-tls), [`bare-tcp`](https://github.com/holepunchto/bare-tcp)
|
||||
- `node:http` / `node:https` — [`bare-http1`](https://github.com/holepunchto/bare-http1), [`bare-https`](https://github.com/holepunchto/bare-https); **`ctx`** may expose wrapped **`fetch`**.
|
||||
- `node:http` / `node:https` — [`bare-http1`](https://github.com/holepunchto/bare-http1), [`bare-https`](https://github.com/holepunchto/bare-https); **`ctx**` may expose wrapped `**fetch`**.
|
||||
- `node:worker_threads` — [`bare-worker`](https://github.com/holepunchto/bare-worker), [`bare-thread`](https://github.com/holepunchto/bare-thread)
|
||||
- `node:diagnostics_channel` — [`bare-diagnostics-channel`](https://github.com/holepunchto/bare-diagnostics-channel)
|
||||
- WebSockets / WS upgrade paths — [`bare-ws`](https://github.com/holepunchto/bare-ws) — pair with **`bare-http1`** / **`bare-tls`** for gateways; see handbook ch.11 / transport table in [kernel-extensions.md](../docs/reference/kernel-extensions.md).
|
||||
- Inspector-style probes (non-secret) — [`bare-inspect`](https://github.com/holepunchto/bare-inspect) — boot policy **`maxPearInspectDepth`** caps nested inspect hints merged from **`boot.policy.json`**.
|
||||
- RPC-style delegates — [`bare-rpc`](https://github.com/holepunchto/bare-rpc) — boot policy **`denyBareRpcMethodPatterns`** can deny method-class patterns before they reach guest-visible **`ctx`** probes.
|
||||
- WebSockets / WS upgrade paths — [`bare-ws`](https://github.com/holepunchto/bare-ws) — pair with **`bare-http1**` / `**bare-tls`** for gateways; see handbook ch.11 / transport table in [kernel-extensions.md](../docs/reference/kernel-extensions.md).
|
||||
- Inspector-style probes (non-secret) — [`bare-inspect`](https://github.com/holepunchto/bare-inspect) — boot policy **`maxPearInspectDepth**` caps nested inspect hints merged from `**boot.policy.json`**.
|
||||
- RPC-style delegates — [`bare-rpc`](https://github.com/holepunchto/bare-rpc) — boot policy **`denyBareRpcMethodPatterns**` can deny method-class patterns before they reach guest-visible `**ctx`** probes.
|
||||
|
||||
Stock **`/bin/openssl`** is a **stub** that points integrators at **`bare-crypto`** (see [`packages/bare-os-coreutils/src/openssl.js`](../../packages/bare-os-coreutils/src/openssl.js)).
|
||||
Stock **`/bin/openssl**` is a **stub** that points integrators at `**bare-crypto`** (see [`packages/bare-os-coreutils/src/openssl.js`](../../packages/bare-os-coreutils/src/openssl.js)).
|
||||
|
||||
See also [kernel-extensions.md](../docs/reference/kernel-extensions.md), [handbook ch.11](../handbook/11-kernel-program-and-research.md), and CI **`verify-pear-no-static-node-import.mjs`**.
|
||||
|
||||
**Word 11 (hypercore / pack / HRPC lifecycle):** stock boot policy may pin **`bare-pack`** / **`bare-addon-policy`** (and related) versions via host env keys surfaced in **`boot.policy.json` v11**; Hypercore/replication-heavy guests should prefer Holepunch **`bare-*`** modules over Node **`node:*`** for the same capability areas as in the table above (see **`bits11`** / **`BARE_OS_KERNEL_FEATURES_STOCK_WORD_HYPERCORE_PACK_HRPC_LIFECYCLE`** in [compatibility-matrix.md](../docs/reference/compatibility-matrix.md)).
|
||||
**Word 11 (hypercore / pack / HRPC lifecycle):** stock boot policy may pin **`bare-pack**` / `**bare-addon-policy**` (and related) versions via host env keys surfaced in `**boot.policy.json` v11**; Hypercore/replication-heavy guests should prefer Holepunch **`bare-***` modules over Node `**node:***` for the same capability areas as in the table above (see `**bits11**` / `**BARE_OS_KERNEL_FEATURES_STOCK_WORD_HYPERCORE_PACK_HRPC_LIFECYCLE`** in [compatibility-matrix.md](../docs/reference/compatibility-matrix.md)).
|
||||
|
||||
Reference in New Issue
Block a user