diff options
author | Gabriele Petronella <gabriele@buildo.io> | 2018-03-18 01:36:28 +0900 |
---|---|---|
committer | Li Haoyi <haoyi.sg@gmail.com> | 2018-03-17 09:36:28 -0700 |
commit | 6aba4d619d11e3f7f2c5128aa34162df655af37b (patch) | |
tree | fee45a65ea599b84bdbf86c8143b362d95dbe4bf /docs | |
parent | bc608cdf19720fe2111bb055bd57eedba24dc7ae (diff) | |
download | mill-6aba4d619d11e3f7f2c5128aa34162df655af37b.tar.gz mill-6aba4d619d11e3f7f2c5128aa34162df655af37b.tar.bz2 mill-6aba4d619d11e3f7f2c5128aa34162df655af37b.zip |
Rename 'describe' to 'inspect' in the docs, following 6336860 (#235)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/pages/1 - Intro to Mill.md | 32 | ||||
-rw-r--r-- | docs/pages/6 - Extending Mill.md | 2 |
2 files changed, 17 insertions, 17 deletions
diff --git a/docs/pages/1 - Intro to Mill.md b/docs/pages/1 - Intro to Mill.md index 94ee4a4d..63b69601 100644 --- a/docs/pages/1 - Intro to Mill.md +++ b/docs/pages/1 - Intro to Mill.md @@ -46,7 +46,7 @@ sudo curl -L -o /usr/local/bin/mill https://github.com/lihaoyi/mill/releases/dow More recent, unstable versions of Mill are also [available](https://github.com/lihaoyi/mill/releases/tag/unstable), if you want -to try out the latest features and improvements that are currently in master. +to try out the latest features and improvements that are currently in master. Come by our [Gitter Channel](https://gitter.im/lihaoyi/mill) if you want to ask questions or say hi! @@ -105,7 +105,7 @@ $ mill foo.repl # start an Ammonite REPL within your project ``` You can run `mill resolve __` to see a full list of the different tasks that are -available, `mill resolve foo._` to see the tasks within `foo`, `mill describe +available, `mill resolve foo._` to see the tasks within `foo`, `mill inspect foo.compile` to see what an individual task depends on, or `mill show foo.scalaVersion` to inspect the output of any task. @@ -328,10 +328,10 @@ mill resolve __ # list every module or task recursively mill resolve foo.__ # list every task recursively within the foo module ``` -### describe +### inspect ```bash -$ mill describe core.run +$ mill inspect core.run core.run(ScalaModule.scala:211) Inputs: @@ -341,26 +341,26 @@ Inputs: core.forkEnv ``` -`describe` is a more verbose version of [resolve](#resolve). In addition to +`inspect` is a more verbose version of [resolve](#resolve). In addition to printing out the name of one-or-more tasks, it also display's it's source location and a list of input tasks. This is very useful for debugging and interactively exploring the structure of your build from the command line. -`describe` also works with the same `_`/`__` wildcard/query syntaxes that +`inspect` also works with the same `_`/`__` wildcard/query syntaxes that [all](#all)/[resolve](#resolve) do: ```bash -mill describe foo.compile -mill describe foo.{compile,run} -mill describe "foo.{compile,run}" -mill describe foo.compile foo.run -mill describe _.compile -mill describe __.compile -mill describe _ -mill describe foo._ -mill describe __ -mill describe foo._ +mill inspect foo.compile +mill inspect foo.{compile,run} +mill inspect "foo.{compile,run}" +mill inspect foo.compile foo.run +mill inspect _.compile +mill inspect __.compile +mill inspect _ +mill inspect foo._ +mill inspect __ +mill inspect foo._ ``` ### show diff --git a/docs/pages/6 - Extending Mill.md b/docs/pages/6 - Extending Mill.md index a6c096a6..135a63ed 100644 --- a/docs/pages/6 - Extending Mill.md +++ b/docs/pages/6 - Extending Mill.md @@ -177,7 +177,7 @@ def idea(ev: Evaluator[Any]) = T.command{ ``` Many built-in tools are implemented as custom evaluator commands: -[all](intro.html#all), [describe](intro.html#describe), +[all](intro.html#all), [inspect](intro.html#inspect), [resolve](intro.html#resolve), [show](intro.html#show). If you want a way to run Mill commands and programmatically manipulate the tasks and outputs, you do so with your own evaluator command. |