The machine's settings, which differ from one computer to the next and stay out of what is committed: where
CIRCT is (CIRCT_BIN), and the target's own (on the Tang Primer 25K GOWIN_HOME, UART_PORT, ...).
Each is looked up in order:
- the environment variable (
CIRCT_BIN=...): for CI and one-off overrides; - the application's config,
config :elixir_hls, circt_bin: "...": kept out of git inconfig/local.exs, whichconfig/config.exsimports when it exists (asmix ehls.newwrites them); - the user's config for every application of the machine,
~/.config/ehls/config.exs(the sameconfig :elixir_hls, ...; another file withEHLS_USER_CONFIG); - found on the machine, where the setting knows how (
hlstoolonPATHforCIRCT_BIN); - else not set: the step that needs it stops and says where it looked;
mix ehls.doctorshows them all.
A path beginning with ~ is expanded.
Summary
Types
A setting: its key in the config, its environment variable, a function finding it on the machine (or nil) and what it is.
Functions
The user's cache, shared by every application of the machine: what the flash holds (EHLS.Flash) and what a
target sets up once (mix ehls.setup). ~/.cache/ehls on Linux; another directory with EHLS_CACHE_DIR.
The environment for a target's scripts: each setting that is set, as its variable.
A setting's value by key, or nil.
A setting's value; raises, saying where it looked, when it is not set.
A setting's value and where it came from (:env, :config, :user, :found), or {nil, nil}.
elixir-hls' own settings.
Every setting of the project: elixir-hls' and its target's.
The user's config file.
Types
Functions
The user's cache, shared by every application of the machine: what the flash holds (EHLS.Flash) and what a
target sets up once (mix ehls.setup). ~/.cache/ehls on Linux; another directory with EHLS_CACHE_DIR.
The environment for a target's scripts: each setting that is set, as its variable.
A setting's value by key, or nil.
A setting's value; raises, saying where it looked, when it is not set.
A setting's value and where it came from (:env, :config, :user, :found), or {nil, nil}.
elixir-hls' own settings.
Every setting of the project: elixir-hls' and its target's.
The user's config file.