snxraven/bare-operating-system
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs updates

Browse Source
This commit is contained in:
Raven Scott
2026-04-04 08:31:39 -04:00
parent 0e53351349
commit 081e4c587c
64 changed files with 2052 additions and 1273 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/capability-words.md
+14 -18
View File
@@ -2,29 +2,25 @@
Seed RPC **`bare_os.capabilities`**, **`/proc/bare_os_features`**, and guest **`ctx`** (**`bareOsAdvertisedKernelCapabilityWords`** / **`bareOsSeedKernelCapabilityWords`**) use **wire v2**: eleven unsigned 32-bit masks live under one JSON object **`kernelCapabilityWords`** with **semantic camelCase** keys below. Numeric values and **bit positions** match the legacy v1 layout (top-level **`bits`**, **`bits2`**, … **`bits11`**); only the JSON shape changed.
| `kernelCapabilityWords` key | Semantic label | Stock mask constant (`bare-os-protocol`) | `boot.policy.json` required mask | Proc JSON module (`bare-os-booter`) |
| --- | --- | --- | --- | --- |
| `primary` | `PRIMARY` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PRIMARY` | `minKernelCapabilitiesPrimary` | (core tree; not a single module) |
| `extendedSeedingPlatform` | `EXTENDED_SEEDING_PLATFORM` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_EXTENDED_SEEDING_PLATFORM` | `requireKernelCapabilitiesExtendedSeedingPlatform` | — |
| `rlimitsDelegatesShell` | `RLIMITS_DELEGATES_SHELL` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_RLIMITS_DELEGATES_SHELL` | `requireKernelCapabilitiesRlimitsDelegatesShell` | — |
| `offlineNetExtensions` | `OFFLINE_NET_EXTENSIONS` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_OFFLINE_NET_EXTENSIONS` | `requireKernelCapabilitiesOfflineNetExtensions` | — |
| `hostTransportDelegates` | `HOST_TRANSPORT_DELEGATES` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_HOST_TRANSPORT_DELEGATES` | `requireKernelCapabilitiesHostTransportDelegates` | — |
| `replicationOperatorSurface` | `REPLICATION_OPERATOR_SURFACE` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_REPLICATION_OPERATOR_SURFACE` | `requireKernelCapabilitiesReplicationOperatorSurface` | `bare-os-proc-replication-operator-surface.js` |
| `pearCorestoreHrpc` | `PEAR_CORESTORE_HRPC` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PEAR_CORESTORE_HRPC` | `requireKernelCapabilitiesPearCorestoreHrpc` | `bare-os-proc-pear-corestore-hrpc.js` |
| `bareRuntimeProtoMux` | `BARE_RUNTIME_PROTO_MUX` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_BARE_RUNTIME_PROTO_MUX` | `requireKernelCapabilitiesBareRuntimeProtoMux` | `bare-os-proc-bare-runtime-proto-mux.js` |
| `bareModuleCryptoStaging` | `BARE_MODULE_CRYPTO_STAGING` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_BARE_MODULE_CRYPTO_STAGING` | `requireKernelCapabilitiesBareModuleCryptoStaging` | `bare-os-proc-bare-module-crypto-staging.js` |
| `pearInspectLoggerTls` | `PEAR_INSPECT_LOGGER_TLS` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PEAR_INSPECT_LOGGER_TLS` | `requireKernelCapabilitiesPearInspectLoggerTls` | `bare-os-proc-pear-inspect-logger-tls.js` |
| `hypercorePackHrpcLifecycle` | `HYPERCORE_PACK_HRPC_LIFECYCLE` | `BARE_OS_KERNEL_FEATURES_STOCK_WORD_HYPERCORE_PACK_HRPC_LIFECYCLE` | `requireKernelCapabilitiesHypercorePackHrpcLifecycle` | `bare-os-proc-hypercore-pack-hrpc-lifecycle.js` |
- `primary` — `PRIMARY` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PRIMARY` — `minKernelCapabilitiesPrimary` — (core tree; not a single module)
- `extendedSeedingPlatform` — `EXTENDED_SEEDING_PLATFORM` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_EXTENDED_SEEDING_PLATFORM` — `requireKernelCapabilitiesExtendedSeedingPlatform` — —
- `rlimitsDelegatesShell` — `RLIMITS_DELEGATES_SHELL` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_RLIMITS_DELEGATES_SHELL` — `requireKernelCapabilitiesRlimitsDelegatesShell` — —
- `offlineNetExtensions` — `OFFLINE_NET_EXTENSIONS` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_OFFLINE_NET_EXTENSIONS` — `requireKernelCapabilitiesOfflineNetExtensions` — —
- `hostTransportDelegates` — `HOST_TRANSPORT_DELEGATES` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_HOST_TRANSPORT_DELEGATES` — `requireKernelCapabilitiesHostTransportDelegates` — —
- `replicationOperatorSurface` — `REPLICATION_OPERATOR_SURFACE` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_REPLICATION_OPERATOR_SURFACE` — `requireKernelCapabilitiesReplicationOperatorSurface` — `bare-os-proc-replication-operator-surface.js`
- `pearCorestoreHrpc` — `PEAR_CORESTORE_HRPC` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PEAR_CORESTORE_HRPC` — `requireKernelCapabilitiesPearCorestoreHrpc` — `bare-os-proc-pear-corestore-hrpc.js`
- `bareRuntimeProtoMux` — `BARE_RUNTIME_PROTO_MUX` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_BARE_RUNTIME_PROTO_MUX` — `requireKernelCapabilitiesBareRuntimeProtoMux` — `bare-os-proc-bare-runtime-proto-mux.js`
- `bareModuleCryptoStaging` — `BARE_MODULE_CRYPTO_STAGING` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_BARE_MODULE_CRYPTO_STAGING` — `requireKernelCapabilitiesBareModuleCryptoStaging` — `bare-os-proc-bare-module-crypto-staging.js`
- `pearInspectLoggerTls` — `PEAR_INSPECT_LOGGER_TLS` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_PEAR_INSPECT_LOGGER_TLS` — `requireKernelCapabilitiesPearInspectLoggerTls` — `bare-os-proc-pear-inspect-logger-tls.js`
- `hypercorePackHrpcLifecycle` — `HYPERCORE_PACK_HRPC_LIFECYCLE` — `BARE_OS_KERNEL_FEATURES_STOCK_WORD_HYPERCORE_PACK_HRPC_LIFECYCLE` — `requireKernelCapabilitiesHypercorePackHrpcLifecycle` — `bare-os-proc-hypercore-pack-hrpc-lifecycle.js`
**Offline LKG:** `boot.policy.json` boolean **`offlineLkgRequireHypercorePackHrpcLifecycle`** sets host env **`BARE_OS_OFFLINE_LKG_REQUIRE_HYPERCORE_PACK_HRPC_LIFECYCLE=1`** (strict class hints for the eleventh word).
**Probe env (telemetry):**
| Env var | Word |
| --- | --- |
| `BARE_OS_PROBE_ID_BARE_MODULE_CRYPTO_STAGING` | ninth word |
| `BARE_OS_PROBE_ID_PEAR_INSPECT_LOGGER_TLS` | tenth word |
| `BARE_OS_PROBE_ID_HYPERCORE_PACK_HRPC_LIFECYCLE` | eleventh word |
- `BARE_OS_PROBE_ID_BARE_MODULE_CRYPTO_STAGING` — ninth word
- `BARE_OS_PROBE_ID_PEAR_INSPECT_LOGGER_TLS` — tenth word
- `BARE_OS_PROBE_ID_HYPERCORE_PACK_HRPC_LIFECYCLE` — eleventh word
**Proc visibility:** `BARE_OS_HIDE_PROC_HYPERCORE_PACK_HRPC_LIFECYCLE` (`0` / `false` / `off`) omits eleventh-word **`/proc`** JSON entries from directory listings, resolution, and the proc index.