style: run oxfmt repo-wide
First full pass of the pnpm fmt toolchain: markdown table alignment, TOML array wrapping, CSS/HTML expansion in the enclosure concept page. No content changes; mermaid blocks untouched.
This commit is contained in:
Julien Calixte
@@ -4,7 +4,7 @@ target = "xtensa-esp32s3-espidf"
|
||||
[target.'cfg(target_os = "espidf")']
|
||||
linker = "ldproxy"
|
||||
runner = "espflash flash --monitor --baud 921600"
|
||||
rustflags = [ "--cfg", "espidf_time64"]
|
||||
rustflags = ["--cfg", "espidf_time64"]
|
||||
|
||||
[unstable]
|
||||
build-std = ["std", "panic_abort"]
|
||||
|
||||
@@ -92,7 +92,7 @@ required-features = ["git"]
|
||||
opt-level = "s"
|
||||
|
||||
[profile.dev]
|
||||
debug = true # Symbols are nice, and they don't increase the size on Flash
|
||||
debug = true # Symbols are nice, and they don't increase the size on Flash
|
||||
opt-level = "z"
|
||||
[patch.crates-io]
|
||||
esp-idf-sys = { git = "https://github.com/esp-rs/esp-idf-sys.git" }
|
||||
@@ -129,7 +129,11 @@ git2 = { version = "0.20", default-features = false, optional = true }
|
||||
# (GIT_OPT_SET_CACHE_MAX_SIZE) and cache telemetry (GIT_OPT_GET_CACHED_MEMORY)
|
||||
# that git_sync sets against the run-4 push OOM (2026-07-13).
|
||||
libgit2-sys = { version = "0.18", default-features = false, optional = true }
|
||||
esp-idf-svc = { version = "0.52.1", features = ["critical-section", "embassy-time-driver", "embassy-sync"] }
|
||||
esp-idf-svc = { version = "0.52.1", features = [
|
||||
"critical-section",
|
||||
"embassy-time-driver",
|
||||
"embassy-sync",
|
||||
] }
|
||||
# Remove `generic-queue-8` if you plan to use `embassy-time` WITH `embassy-executor`
|
||||
embassy-time = { version = "0.5", features = ["generic-queue-8"] }
|
||||
embedded-graphics = "0.8"
|
||||
|
||||
@@ -86,7 +86,7 @@ atomic round-trip byte-identical. Two findings baked into the code:
|
||||
- **FatFS rename ≠ POSIX rename.** `f_rename` won't overwrite an existing
|
||||
target (returns `FR_EXIST`), so the atomic save unlinks the destination first.
|
||||
`firmware::persistence` pairs this with `*.tmp` boot-recovery
|
||||
(`Storage::recover`): if a `*.tmp` is found *alongside* the target the crash
|
||||
(`Storage::recover`): if a `*.tmp` is found _alongside_ the target the crash
|
||||
may have been mid-write, so it keeps the committed file and discards the tmp;
|
||||
it only promotes the tmp when the target was already unlinked. Long filenames
|
||||
(`CONFIG_FATFS_LFN_HEAP`) are required for the two-dot `*.md.tmp` name.
|
||||
@@ -196,10 +196,10 @@ a switch. The nominal build turns it on (it's the product); a **light** build
|
||||
leaves it off — ideal for iterating on the editor, EPD, USB, or SD without
|
||||
paying for libgit2:
|
||||
|
||||
| Build | Command | libgit2 component | `git2` crate | `:gp` |
|
||||
| ----- | ------- | ----------------- | ------------ | ------- |
|
||||
| **Full / git** (default) | `just build` / `just flash` | compiled | linked | save → push |
|
||||
| **Light** | `just build-light` / `just flash-light` | not compiled (empty no-op) | not linked | saves locally, skips push |
|
||||
| Build | Command | libgit2 component | `git2` crate | `:gp` |
|
||||
| ------------------------ | --------------------------------------- | -------------------------- | ------------ | ------------------------- |
|
||||
| **Full / git** (default) | `just build` / `just flash` | compiled | linked | save → push |
|
||||
| **Light** | `just build-light` / `just flash-light` | not compiled (empty no-op) | not linked | saves locally, skips push |
|
||||
|
||||
Two independent switches make this work, and the justfile flips them together:
|
||||
|
||||
@@ -209,7 +209,7 @@ Two independent switches make this work, and the justfile flips them together:
|
||||
pass it.
|
||||
2. **`LIBGIT2_SRC` env** — the [libgit2 component](components/libgit2/CMakeLists.txt)
|
||||
only compiles its sources when this points at the vendored tree; unset, it
|
||||
registers an *empty* component. Only the full recipes set it.
|
||||
registers an _empty_ component. Only the full recipes set it.
|
||||
|
||||
Because git code in the firmware binary is only ever compiled under
|
||||
`--features git`, `just build-light` can never drag libgit2 in. (Git isn't wired
|
||||
@@ -258,14 +258,14 @@ since a wrong guess would let `rsync --delete` wipe the wrong disk's `repo/`.
|
||||
a ladder — `.env` if present, else derived from tools already on the machine,
|
||||
else an interactive prompt with the derived value as the default:
|
||||
|
||||
| Value | Derived from |
|
||||
| --- | --- |
|
||||
| `TW_REMOTE_URL` | the source repo's `origin` (or the card's existing clone) |
|
||||
| `TW_AUTHOR_NAME` / `TW_AUTHOR_EMAIL` | `git config user.name` / `user.email` |
|
||||
| `TW_GH_USER` | `gh api user` |
|
||||
| `TW_WIFI_SSID` | the Mac's active Wi-Fi network |
|
||||
| `TW_WIFI_PASS` | the System keychain for that SSID (else prompt) |
|
||||
| `TW_PAT` | **never derived** — always typed by hand |
|
||||
| Value | Derived from |
|
||||
| ------------------------------------ | --------------------------------------------------------- |
|
||||
| `TW_REMOTE_URL` | the source repo's `origin` (or the card's existing clone) |
|
||||
| `TW_AUTHOR_NAME` / `TW_AUTHOR_EMAIL` | `git config user.name` / `user.email` |
|
||||
| `TW_GH_USER` | `gh api user` |
|
||||
| `TW_WIFI_SSID` | the Mac's active Wi-Fi network |
|
||||
| `TW_WIFI_PASS` | the System keychain for that SSID (else prompt) |
|
||||
| `TW_PAT` | **never derived** — always typed by hand |
|
||||
|
||||
So a first run is usually: `just init ~/code/notes`, press Enter through the
|
||||
auto-filled defaults, approve the macOS Keychain dialog for the Wi-Fi password
|
||||
|
||||
Reference in New Issue
Block a user