TNT-Flo/bare-operating-system
1
0
Fork 0
forked from snxraven/bare-operating-system
Code Pull Requests 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
packages/bare-os-protocol/CHANGELOG.md
+2
View File
@@ -1,5 +1,7 @@
# Changelog — `bare-os-protocol`
Cross-package **version alignment** (ctx API, feature-bits doc, lifecycle schema) is summarized in [`docs/reference/compatibility-matrix.md`](../../docs/reference/compatibility-matrix.md).
## 0.9.0
- **Breaking (wire):** **`bare_os.capabilities`** and related surfaces use **`kernelCapabilityWords`** (semantic camelCase keys) plus **`kernelCapabilityWireVersion: 2`** instead of top-level **`bits`** … **`bits11`**. Numeric masks and bit positions are unchanged; peers must upgrade together.
packages/bare-os-protocol/README.md
+7 -7
View File
@@ -2,15 +2,15 @@
Shared **wire format and constants** for the Bare operating system monorepo: Hyperswarm topic, 512-byte MBR layout, and Protomux **bare-os-v1** seed-channel message shapes.
**Documentation:** [Protocol reference](../../docs/reference/package-bare-os-protocol.md) · [Kernel extensions](../../docs/reference/kernel-extensions.md) · [Handbook ch.3](../../handbook/03-protocol-and-disk.md).
## What it provides
| Export (from `index.js`) | Role |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `PROTOCOL_NAME`, `TOPIC_STRING` | Protomux channel name and swarm topic input string (`bare-os-v1`) |
| `topicKey()` | 32-byte topic for `swarm.join()` |
| `BLOCK_SIZE`, `MBR_MAGIC` | 512-byte MBR, magic `BIOS` at offset 0 |
| `buildMbr` / `parseMbr` | Pack/unpack primary + optional failover Hyperdrive keys |
| `setupSeedChannel` | Wire Protomux messages 0–6 for RAM block reads, gossip bitfield, manifest path **search**, **RPC** (incl. `bare_os.capabilities` with **`bits`** … **`bits11`** when non-zero, typed errors for unknown RPC methods, `bare_os.replication_status`, `bare_os.replication_queue`, extended RPC short names in **`seed-rpc-methods.js`**, `bare_os.gossip`), and `drive.replicate` |
- **`PROTOCOL_NAME`, `TOPIC_STRING`** — Protomux channel name and swarm topic input string (`bare-os-v1`)
- **`topicKey()`** — 32-byte topic for `swarm.join()`
- **`BLOCK_SIZE`, `MBR_MAGIC`** — 512-byte MBR, magic `BIOS` at offset 0
- **`buildMbr` / `parseMbr`** — Pack/unpack primary + optional failover Hyperdrive keys
- **`setupSeedChannel`** — Wire Protomux messages 0–6 for RAM block reads, gossip bitfield, manifest path **search**, **RPC** (incl. `bare_os.capabilities` with **`bits`** … **`bits11`** when non-zero, typed errors for unknown RPC methods, `bare_os.replication_status`, `bare_os.replication_queue`, extended RPC short names in **`seed-rpc-methods.js`**, `bare_os.gossip`), and `drive.replicate`
Subpath exports: `bare-os-protocol/constants.js`, `bare-os-protocol/messages` (compact-encoding schemas), `bare-os-protocol/kernel-feature-bits.js` (documented booter capability words **`BARE_OS_KERNEL_FEATURES_STOCK_WORD_*`**; **`BARE_OS_KERNEL_FEATURE_BITS_DOC=14`**; surfaced in **`/proc/bare_os_features`** and **`/proc/bare_os/`**), `bare-os-protocol/lib/seed-rpc-methods.js` (authoritative **`bare_os.*`** RPC name list for **`kernel_info`**), `bare-os-protocol/protocol-meta.js` (**`BARE_OS_PROTOCOL_PACKAGE_VERSION`** for the seed handshake).