julien/typewriter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(firmware): flip build-mode docs to git-default

Browse Source
This commit is contained in:
Julien Calixte
2026-07-11 12:47:57 +02:00
parent 9101d61045
commit ee00fecdc8
3 changed files with 43 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
firmware/Cargo.toml
View File

@@ -76,15 +76,16 @@ esp-idf-hal = { git = "https://github.com/esp-rs/esp-idf-hal.git" }
esp-idf-svc = { git = "https://github.com/esp-rs/esp-idf-svc.git" }
[features]
# OFF by default so the nominal `just build`/`just flash` is a LIGHT editor
# build. Enabling it (a) pulls the git2 safe API and (b) gates on the firmware's
# `:sync` publish path in main.rs (see `publish()`), so git code is only ever
# compiled with `--features git`. libgit2 itself is built by the esp-idf
# component (firmware/components/libgit2/) with mbedTLS — but ONLY when the
# justfile also sets LIBGIT2_SRC (the git recipes do; the light recipes don't,
# so the component is an empty no-op). git2/libgit2-sys run in system mode
# (LIBGIT2_NO_VENDOR=1) purely for the Rust bindings, with default features off
# to avoid dragging in openssl-sys/libssh2-sys.
# A Cargo feature, OFF by default — so a bare `cargo build` (and `just
# build-light`) is a LIGHT editor build. The justfile's nominal `build`/`flash`
# opt in via `--features git`. Enabling it (a) pulls the git2 safe API and (b)
# turns on the `#[cfg(feature = "git")]` publish path in main.rs (see
# `publish()`), so git code is only ever compiled with `--features git`. libgit2
# itself is built by the esp-idf component (firmware/components/libgit2/) with
# mbedTLS — but ONLY when the justfile also sets LIBGIT2_SRC (the full recipes
# do; `build-light` doesn't, so the component is an empty no-op). git2/libgit2-sys
# run in system mode (LIBGIT2_NO_VENDOR=1) purely for the Rust bindings, with
# default features off to avoid dragging in openssl-sys/libssh2-sys.
git = ["dep:git2"]
[dependencies]