Skip to content

Commit a77e97c

Browse files
authored
Merge pull request #34 from ausimian/fix/appup-compiler-naming
docs: name only the relup task for Castle
2 parents f93566f + 61afc96 commit a77e97c

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,13 @@ upgrades. This includes:
1111
the standard Mix launcher.
1212

1313
Additionally, `Forecastle` ships with an appup compiler and a mix task for relup
14-
generation. Both are named for `Castle` rather than for the package that
15-
implements them - `mix castle.relup` and the `:appup` compiler - because where the
16-
build-time code lives is a packaging decision, and what a developer types is not.
14+
generation. The task is `mix castle.relup`, named for `Castle` rather than for
15+
the package that implements it, because where the build-time code lives is a
16+
packaging decision and what a developer types is not.
17+
18+
The compiler is named for neither package. It is `mix compile.appup`, reached
19+
through the project's `:compilers` list rather than invoked by name, so there is
20+
no `mix castle.appup`.
1721

1822
## Installation
1923

lib/mix/tasks/castle.relup.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ defmodule Mix.Tasks.Castle.Relup do
22
@moduledoc """
33
Generate a relup file between releases.
44
5-
This task is provided by `Forecastle`, Castle's build-time half, and named
6-
`castle.*` like the rest of the tooling a developer runs.
5+
This task is provided by `Forecastle`, Castle's build-time half, and named for
6+
`Castle` because that is the package a project depends on.
77
88
`mix castle.relup` will generate a relup between a `target` release and
99
any number of other releases. The paths specifed in the options should

0 commit comments

Comments
 (0)