Nerves.Package (nerves v1.7.0) View Source

Defines a Nerves package struct and helper functions.

A Nerves package is a Mix application that defines the configuration for a Nerves system or Nerves toolchain. For more details, see the Nerves system documentation

Link to this section Summary

Functions

Takes the path to the package and returns the path to its package config.

Loads the package config and parses it into a %Package{}

Starts an interactive shell with the working directory set to the package path

Link to this section Types

Specs

t() :: %Nerves.Package{
  app: atom(),
  build_runner: atom(),
  compilers: [atom()],
  config: Keyword.t(),
  dep: :project | :path | :hex | :git,
  dep_opts: Keyword.t(),
  path: binary(),
  platform: atom(),
  type: :system | :package | :toolchain,
  version: Version.t()
}

Link to this section Functions

Specs

config_path(String.t()) :: String.t()

Takes the path to the package and returns the path to its package config.

Specs

load_config({app :: atom(), path :: String.t()}) :: t()

Loads the package config and parses it into a %Package{}

Specs

shell(t()) :: :ok

Starts an interactive shell with the working directory set to the package path