Skip to content

Commit 41f877e

Browse files
api.md: regenerate from nasty@da2092c
1 parent 211812e commit 41f877e

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

api.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,13 @@ Return hostname, OS version, uptime, bcachefs-tools version info.
195195
| `bcachefs_debug_checks` | boolean | yes | Whether the RUNNING bcachefs module was built with debug checks.
196196
Only true when debug checks are configured AND the system has been rebooted into it. |
197197
| `bcachefs_debug_symbols` | boolean | yes | Whether the loaded bcachefs kernel module contains debug symbols. |
198-
| `bcachefs_is_custom` | boolean | yes | True when the RUNNING bcachefs module version differs from the default. |
198+
| `bcachefs_is_custom` | boolean | yes | True when the running bcachefs kernel module version doesn't
199+
match the wrapper's currently-pinned `bcachefs-tools` ref —
200+
i.e. an upgrade or pin change has activated a new generation
201+
but the box hasn't been rebooted into it yet. The WebUI uses
202+
this to surface a top-bar "reboot pending" cue. False when
203+
the running version probe fails (unknown) or the wrapper has
204+
no pinned ref to compare against. |
199205
| `bcachefs_pinned_ref` | string | no | The ref currently pinned in `/etc/nixos/flake.lock` for `bcachefs-tools`. |
200206
| `bcachefs_version` | string | yes | Output of `bcachefs version` (first line). |
201207
| `engine_built` | string | no | Build timestamp of the engine binary. |
@@ -2873,8 +2879,15 @@ Enum: `celsius`, `fahrenheit`
28732879

28742880
| Field | Type | Required | Description |
28752881
|-------|------|:--------:|-------------|
2876-
| `name` | string | yes | Flake input name (e.g. `nixpkgs`). |
2882+
| `name` | string | yes | Flake input name (e.g. `bcachefs-tools`, `nasty`). |
28772883
| `rev` | string | no | Locked commit SHA from `/etc/nixos/flake.lock` (shortened to 12 chars). |
2884+
| `tag` | string | no | Human-meaningful ref string from `flake.lock`'s
2885+
`nodes[<name>].original.ref` — typically a tag like `v1.38.3`
2886+
or a branch name like `main`. When present, prefer this for
2887+
display over `rev` (which is just a 12-char SHA prefix).
2888+
`None` when the lock node has no `original.ref` set (e.g.
2889+
inputs referenced by raw commit hash, or inputs the lock
2890+
doesn't carry an `original` block for). |
28782891
| `url` | string | yes | Exact `input.url` string from `/etc/nixos/flake.nix`. |
28792892

28802893
### `VersionSwitchInput`

0 commit comments

Comments
 (0)