update docs

wookay · Jan 23, 2019 · 6ac131d · 6ac131d
1 parent 34d564f
commit 6ac131d
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -22,26 +22,26 @@ run the test files from the specific directory.
 
 ```julia
 using Jive
-runtests(@__DIR__, skip=[], node1=[])
+runtests(@__DIR__, skip=[], node1=[], targets=ARGS)
 ```
 ![runtests.svg](https://wookay.github.io/docs/Jive.jl/assets/jive/runtests.svg)
 
-for the `runtests.jl`, `ARGS` are used to filter the targets and to set the first one to test.
+for the `runtests.jl`, `ARGS` are used to filter the targets and to set the start offset of the tests.
 
 ```
 ~/.julia/dev/Jive/test $ julia --color=yes runtests.jl jive/s jive/m start=3
 1/5 jive/mockup/mockup.jl --
-2/5 jive/mockup/warn-replacing-mock.jl --
-3/5 jive/skip/skip-calls.jl
-    Pass 2  (0.26 seconds)
+2/5 jive/skip/skip-calls.jl --
+3/5 jive/skip/skip-exprs.jl
+    Pass 4  (0.38 seconds)
 4/5 jive/skip/skip-functions.jl
+    Pass 4  (0.05 seconds)
+5/5 jive/skip/skip-modules.jl
     Pass 4  (0.01 seconds)
-5/5 jive/skip/skip.jl
-    Pass 4  (0.01 seconds)
-✅  All 10 tests have been completed.  (0.57 seconds)
+✅  All 12 tests have been completed.  (0.73 seconds)
 ```
 
-in the above example, test files are matched for only have `jive/s` `jive/m` and jump up to the 3rd file.
+in the above example, test files are matched for only have `jive/s` `jive/m` and jumping up to the 3rd file.
 
 ### Examples
 
@@ -67,6 +67,8 @@ in the above example, test files are matched for only have `jive/s` `jive/m` and
 ~/.julia/dev/Jive $ julia --color=yes --project=. -e 'ENV["JIVE_PROCS"]="2"; using Pkg; Pkg.test()'
 ```
 
+see also [travis job logs](https://travis-ci.org/wookay/Jive.jl/jobs/483203342#L452).
+
 
 # watch
 
@@ -89,8 +91,8 @@ end
 
 ~/.julia/dev/Jive/test/Example/test $ julia --project=.. -q -i revise.jl example
 watching folders ...
-  - example
   - ../src
+  - example
 ```
 
 when saving any files in the watching folders, it automatically run tests.

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -17,26 +17,26 @@ run the test files from the specific directory.
 
 ```julia
 using Jive
-runtests(@__DIR__, skip=[], node1=[])
+runtests(@__DIR__, skip=[], node1=[], targets=ARGS)
 ```
 ![runtests.svg](https://wookay.github.io/docs/Jive.jl/assets/jive/runtests.svg)
 
-for the `runtests.jl`, `ARGS` are used to filter the targets and to set the first one to test.
+for the `runtests.jl`, `ARGS` are used to filter the targets and to set the start offset of the tests.
 
 ```
 ~/.julia/dev/Jive/test $ julia --color=yes runtests.jl jive/s jive/m start=3
 1/5 jive/mockup/mockup.jl --
-2/5 jive/mockup/warn-replacing-mock.jl --
-3/5 jive/skip/skip-calls.jl
-    Pass 2  (0.26 seconds)
+2/5 jive/skip/skip-calls.jl --
+3/5 jive/skip/skip-exprs.jl
+    Pass 4  (0.38 seconds)
 4/5 jive/skip/skip-functions.jl
+    Pass 4  (0.05 seconds)
+5/5 jive/skip/skip-modules.jl
     Pass 4  (0.01 seconds)
-5/5 jive/skip/skip.jl
-    Pass 4  (0.01 seconds)
-✅  All 10 tests have been completed.  (0.57 seconds)
+✅  All 12 tests have been completed.  (0.73 seconds)
 ```
 
-in the above example, test files are matched for only have `jive/s` `jive/m` and jump up to the 3rd file.
+in the above example, test files are matched for only have `jive/s` `jive/m` and jumping up to the 3rd file.
 
 ### Examples
 
@@ -62,10 +62,12 @@ in the above example, test files are matched for only have `jive/s` `jive/m` and
 ~/.julia/dev/Jive $ julia --color=yes --project=. -e 'ENV["JIVE_PROCS"]="2"; using Pkg; Pkg.test()'
 ```
 
+see also [travis job logs](https://travis-ci.org/wookay/Jive.jl/jobs/483203342#L452).
+
 
 # watch
 
-watch the folders.
+watch the folders. You may need to install [Revise.jl](https://github.com/timholy/Revise.jl).
 
 ```sh
 ~/.julia/dev/Jive/test/Example/test $ cat runtests.jl
@@ -84,8 +86,8 @@ end
 
 ~/.julia/dev/Jive/test/Example/test $ julia --project=.. -q -i revise.jl example
 watching folders ...
-  - example
   - ../src
+  - example
 ```
 
 when saving any files in the watching folders, it automatically run tests.

diff --git a/docs/src/runtests.md b/docs/src/runtests.md
@@ -8,26 +8,26 @@ Jive.runtests
 
 ```julia
 using Jive
-runtests(@__DIR__, skip=[], node1=[])
+runtests(@__DIR__, skip=[], node1=[], targets=ARGS)
 ```
 ![runtests.svg](https://wookay.github.io/docs/Jive.jl/assets/jive/runtests.svg)
 
-for the `runtests.jl`, `ARGS` are used to filter the targets and to set the first one to test.
+for the `runtests.jl`, `ARGS` are used to filter the targets and to set the start offset of the tests.
 
 ```
 ~/.julia/dev/Jive/test $ julia --color=yes runtests.jl jive/s jive/m start=3
 1/5 jive/mockup/mockup.jl --
-2/5 jive/mockup/warn-replacing-mock.jl --
-3/5 jive/skip/skip-calls.jl
-    Pass 2  (0.26 seconds)
+2/5 jive/skip/skip-calls.jl --
+3/5 jive/skip/skip-exprs.jl
+    Pass 4  (0.38 seconds)
 4/5 jive/skip/skip-functions.jl
+    Pass 4  (0.05 seconds)
+5/5 jive/skip/skip-modules.jl
     Pass 4  (0.01 seconds)
-5/5 jive/skip/skip.jl
-    Pass 4  (0.01 seconds)
-✅  All 10 tests have been completed.  (0.57 seconds)
+✅  All 12 tests have been completed.  (0.73 seconds)
 ```
 
-in the above example, test files are matched for only have `jive/s` `jive/m` and jump up to the 3rd file.
+in the above example, test files are matched for only have `jive/s` `jive/m` and jumping up to the 3rd file.
 
 ### Examples
 
@@ -43,7 +43,7 @@ in the above example, test files are matched for only have `jive/s` `jive/m` and
 
 * distributed run tests with `-p`
 ```sh
-~/.julia/dev/Jive/test $ julia --color=yes -p1 runtests.jl
+~/.julia/dev/Jive/test $ julia --color=yes -p3 runtests.jl
 ```
 
 * distributed run tests for `Pkg.test()`, using `JIVE_PROCS` ENV.
@@ -52,3 +52,5 @@ in the above example, test files are matched for only have `jive/s` `jive/m` and
 
 ~/.julia/dev/Jive $ julia --color=yes --project=. -e 'ENV["JIVE_PROCS"]="2"; using Pkg; Pkg.test()'
 ```
+
+see also [travis job logs](https://travis-ci.org/wookay/Jive.jl/jobs/483203342#L452).