Nerves.System.Defconfig (nerves_system_linter v0.4.1)

Elixir representation of a defconfig. Currently only supports buildroot defconfigs and not Linux Kernel configs.

Summary

Types

config()

The actual config representation.

config_name()

Name of a config.

package_value()

Value inside a defconfig.

path()

Path to the file this data represents.

t()

Elixir representation of a defconfig file.

Functions

add_rule(config, rule)

Add a single rule to a defconfig.

add_rules(config, rules)

Add a list of rules to a Defconfig.

Types

config()

@type config() :: %{optional(config_name()) => package_value()}

The actual config representation.

config_name()

@type config_name() :: binary()

Name of a config.

package_value()

@type package_value() :: boolean() | binary() | [binary()]

Value inside a defconfig.

path()

@type path() :: Path.t()

Path to the file this data represents.

t()

@type t() :: %Nerves.System.Defconfig{
  config: config(),
  errors: [Nerves.System.Linter.Rule.Callbacks.message()],
  path: path(),
  rules: [Nerves.System.Linter.Rule.rule()],
  success: [Nerves.System.Linter.Rule.Callbacks.message()],
  warnings: [Nerves.System.Linter.Rule.Callbacks]
}

Elixir representation of a defconfig file.

Functions

add_rule(config, rule)

@spec add_rule(Defconfig.t(), Nerves.System.Linter.Rule.rule()) :: Defconfig.t()

Add a single rule to a defconfig.

add_rules(config, rules)

@spec add_rules(Defconfig.t(), [Nerves.System.Linter.Rule.rule()]) :: Defconfig.t()

Add a list of rules to a Defconfig.