Skip to content

Commit f1db0ba

Browse files
committed
Language updates
1 parent d2fe23c commit f1db0ba

File tree

1 file changed

+21
-29
lines changed

1 file changed

+21
-29
lines changed

CHANGELOG.md

+21-29
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,11 @@
22

33
## v0.8.0
44

5-
In the last relase (0.7.x) we added two additional aliases `deps.get` and
6-
`deps.update`. In this release, we added an alias for `run`.
7-
This led to a point where is became unreasonable to manage
8-
all the required aliases in the project `mix.exs`. We changed the pratice to
9-
allow `nerves_bootstrap` to manage the required aliases for you by calling
10-
`Nerves.Bootstrap.add_aliases/1`, however, this causes users who
11-
did not have the `nerves_bootstrap` archive installed to be stuck in an error
12-
loop unless they would cd to a directory that did not contain an offending
13-
`mix.exs` file to install the missing archive.
5+
The v0.7.x and earlier releases only required two aliases in your `mix.exs` to
6+
pull in the Nerves enhancements to `mix.exs`. This releases adds more aliases.
7+
Rather than requiring your `mix.exs` file to be updated if the Nerves aliase
8+
hooks change in the future, we recommend updating your `mix.exs` as follows:
149

15-
This version provides a safer way of allowing `nerves_bootstrap` to manage
16-
its required aliases by hooking into a single alias: `loadconfig`.
17-
18-
19-
To update, you will need to modify your `mix.exs` to the following:
2010
```elixir
2111
# mix.exs
2212

@@ -27,20 +17,22 @@ To update, you will need to modify your `mix.exs` to the following:
2717
]
2818
end
2919

30-
# Starting nerves_bootstrap adds the required aliases to Mix.Project.config()
31-
# Aliases are only added if MIX_TARGET is set.
32-
def bootstrap(args) do
20+
# Starting nerves_bootstrap pulls in the Nerves hooks to mix, but only
21+
# if the MIX_TARGET environment variable is set.
22+
defp bootstrap(args) do
3323
Application.start(:nerves_bootstrap)
3424
Mix.Task.run("loadconfig", args)
3525
end
3626
```
3727

28+
This release has the following changes:
29+
3830
* Enhancements
39-
* `precompile` will compile all Nerves packages instead of only the system
40-
and its children.
41-
* Calling `run` while `MIX_TARGET` is set will raise an exception for
42-
trying to run cross compiled code on the host.
43-
* `Application.start(:nerves_bootstrap)` will attempt to add aliases to the
31+
* `precompile` will compile all Nerves packages instead of only the system and
32+
its children.
33+
* Calling `run` while `MIX_TARGET` is set will raise an exception for trying
34+
to run cross compiled code on the host.
35+
* `Application.start(:nerves_bootstrap)` will attempt to add aliases to the
4436
mix project on the top of the stack if `MIX_TARGET` is set.
4537

4638
## v0.7.1
@@ -55,9 +47,9 @@ To update, you will need to modify your `mix.exs` to the following:
5547
* `nerves_bootstrap` will check for updates when `nerves.deps.get` is called.
5648
* Added `Nerves.Bootstrap.add_aliases/1`
5749
This helper function ensures that your project has the required Nerves
58-
mix aliases defined and in the correct execution order. The function takes
50+
mix aliases defined and in the correct execution order. The function takes
5951
the existing aliases as a keyword list and injects the required Nerves aliases.
60-
You will need to update your `mix.exs` target aliases to use this version of
52+
You will need to update your `mix.exs` target aliases to use this version of
6153
`nerves_bootstrap` like this:
6254

6355
```elixir
@@ -72,11 +64,11 @@ To update, you will need to modify your `mix.exs` to the following:
7264
You should also update your required dependency for nerves to
7365
`{:nerves, "~> 0.9", runtime: false}`
7466
* Bug Fixes
75-
* disable precompiler when calling `mix nerves.clean` to prevent having to
67+
* disable precompiler when calling `mix nerves.clean` to prevent having to
7668
build the package so we can clean it.
77-
* Fixes issue where project dependencies that contain calls to `System.get_env`
78-
in their config or mix file or rebar deps that have `rebar-config.script`
79-
overrides that make `os:getenv` calls were not being configured for the
69+
* Fixes issue where project dependencies that contain calls to `System.get_env`
70+
in their config or mix file or rebar deps that have `rebar-config.script`
71+
overrides that make `os:getenv` calls were not being configured for the
8072
cross compile environment.
8173

8274
## v0.6.4
@@ -146,7 +138,7 @@ To update, you will need to modify your `mix.exs` to the following:
146138
`--target` to the generator. Defaults to declaring all officially supported
147139
Nerves Targets.
148140
* A default cookie is generated and placed in the vm.args. the cookie can
149-
be set by passing `--cookie`
141+
be set by passing `--cookie`
150142

151143
## v0.3.1
152144
* Bug Fixes

0 commit comments

Comments
 (0)