Skip to content

Commit fca6ada

Browse files
committed
More options docs clean up
1 parent 243bd92 commit fca6ada

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

lib/ecto/migrator.ex

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -372,14 +372,13 @@ defmodule Ecto.Migrator do
372372
## Options
373373
374374
* `:all` - runs all available if `true`
375+
375376
* `:step` - runs the specific number of migrations
377+
376378
* `:to` - runs all until the supplied version is reached
377-
* `:log` - the level to use for logging. Defaults to `:info`.
378-
Can be any of `Logger.level/0` values or a boolean.
379-
* `:prefix` - the prefix to run the migrations on
380-
* `:dynamic_repo` - the name of the Repo supervisor process.
381-
See `c:Ecto.Repo.put_dynamic_repo/1`.
379+
(including the version given in `:to`)
382380
381+
Plus all other options described in `up/4`.
383382
"""
384383
@spec run(Ecto.Repo.t, String.t | [String.t] | [{integer, module}], atom, Keyword.t) :: [integer]
385384
def run(repo, migration_source, direction, opts) do

lib/mix/tasks/ecto.migrations.ex

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,21 @@ defmodule Mix.Tasks.Ecto.Migrations do
3737
3838
## Command line options
3939
40-
* `-r`, `--repo` - the repo to obtain the status for
40+
* `--migrations-path` - the path to load the migrations from, defaults to
41+
`"priv/repo/migrations"`. This option may be given multiple times in which
42+
case the migrations are loaded from all the given directories and sorted as
43+
if they were in the same one.
44+
45+
Note, if you have previously run migrations from paths `a/` and `b/`, and now
46+
run `mix ecto.migrations --migrations-path a/` (omitting path `b/`), the
47+
migrations from the path `b/` will be shown in the output as `** FILE NOT FOUND **`.
4148
4249
* `--no-compile` - does not compile applications before running
4350
4451
* `--no-deps-check` - does not check dependencies before running
4552
46-
* `--migrations-path` - the path to load the migrations from, defaults to
47-
`"priv/repo/migrations"`. This option may be given multiple times in which case the migrations
48-
are loaded from all the given directories and sorted as if they were in the same one.
53+
* `-r`, `--repo` - the repo to obtain the status for
4954
50-
Note, if you have previously run migrations from e.g. paths `a/` and `b/`, and now run `mix
51-
ecto.migrations --migrations-path a/` (omitting path `b/`), the migrations from the path
52-
`b/` will be shown in the output as `** FILE NOT FOUND **`.
5355
"""
5456

5557
@impl true

0 commit comments

Comments
 (0)