hive-sh4re: state the env-var contract, not who sets it
Per review: the rust code should not explain nix stuff. The original doc comment named nix modules as the setters of HIVE_ASSETS_DIR, and the previous commit here made that worse -- it replaced two stale nix paths with four accurate ones, entrenching a cross-layer explanation instead of removing it. What this crate actually depends on is the env var and the layout it points at. Who sets it belongs to the layer that sets it.
This commit is contained in:
parent
d17aa254dd
commit
1e011bcd93
1 changed files with 3 additions and 5 deletions
|
|
@ -3,11 +3,9 @@
|
||||||
//! (`hive-c0re`) and the in-container harness binaries so they agree
|
//! (`hive-c0re`) and the in-container harness binaries so they agree
|
||||||
//! on the lookup contract.
|
//! on the lookup contract.
|
||||||
//!
|
//!
|
||||||
//! At runtime, the path is read from `$HIVE_ASSETS_DIR`. In nix builds
|
//! At runtime, the path is read from `$HIVE_ASSETS_DIR`. Setting it is
|
||||||
//! that env var is set to `${pkgs.hyperhive-assets}/share/hyperhive` by
|
//! the deployment's job; this crate's contract is only that it names a
|
||||||
//! `nix/host-modules/hive-c0re/environment.nix` (host daemon) and
|
//! directory laid out like the packaged assets.
|
||||||
//! `nix/agent-modules/default.nix` + `agent-service.nix` (containers);
|
|
||||||
//! the package itself is built by `nix/packages/assets.nix`.
|
|
||||||
//! For `cargo run` outside nix, set it yourself:
|
//! For `cargo run` outside nix, set it yourself:
|
||||||
//!
|
//!
|
||||||
//! ```sh
|
//! ```sh
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue