Nerves

v0.8.3

Nerves

Nerves v0.8.3 Nerves.Package 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

Types

t()

Functions

artifact(pkg, toolchain)

Builds the package and produces an artifact. See Nerves.Package.Artifact for more information

checksum(pkg)

Produce a base16 encoded checksum for the package from the list of files and expanded folders listed in the checksum config key

clean(pkg)

Cleans the artifacts for the package providers of all packages

config(app, path)
config_path(path)

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

load_config(arg)

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

shell(pkg)

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

stale?(pkg, toolchain)

Determines if the artifact for a package is stale and needs to be rebuilt

Link to this section Types

Link to this type t() View Source 
t() :: %Nerves.Package{app: atom, config: Keyword.t, dep: :project | :path | :hex | :git, path: binary, platform: atom, provider: atom, type: :system | :package | :toolchain, version: Version.t}

Link to this section Functions

Link to this function artifact(pkg, toolchain) View Source 
artifact(Nerves.Package.t, Nerves.Package.t) :: :ok

Builds the package and produces an artifact. See Nerves.Package.Artifact for more information.

Link to this function checksum(pkg) View Source 
checksum(Nerves.Package.t) :: String.t

Produce a base16 encoded checksum for the package from the list of files and expanded folders listed in the checksum config key.

Link to this function clean(pkg) View Source 
clean(Nerves.Package.t) :: :ok | {:error, term}

Cleans the artifacts for the package providers of all packages

Link to this function config_path(path) View Source 
config_path(String.t) :: String.t

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

Link to this function load_config(arg) View Source 
load_config({app :: atom, path :: String.t}) :: Nerves.Package.t

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

Link to this function shell(pkg) View Source 
shell(Nerves.Package.t) :: :ok

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

Link to this function stale?(pkg, toolchain) View Source 
stale?(Nerves.Package.t, Nerves.Package.t) :: boolean

Determines if the artifact for a package is stale and needs to be rebuilt.