Skip to content
This repository was archived by the owner on Sep 8, 2022. It is now read-only.

Commit 97fa276

Browse files
committed
fix bad markdown in readme
1 parent e3499d0 commit 97fa276

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,39 +10,44 @@ Failed tests will (typically) have a log file (`test/files/$kind/$testName-$kind
1010
that differs from their check file (`test/files/$kind/$testName.check`).
1111

1212
Test categories (subdirectories under `test/files`)
13+
1314
- `pos`: these files must compile successfully
1415
- `run`: in addition to compiling, `Test.main` is run and its output is compared against the test's `.check` file
1516
- `neg`: these files must not compile, with compiler output matching the expected output in the `.check` file
1617
- `jvm`: JVM-specific run tests
1718

1819
As partest links directly against the compiler being tested, it's cross-versioned against
19-
the compiler version that it's intended for.
20+
the compiler version that it's intended for.
2021

2122
There are three ways of invoking partest:
23+
2224
- ant (see https://github.com/scala/scala/blob/2.11.x/test/build-partest.xml and https://github.com/scala/scala-partest/blob/master/src/main/scala/scala/tools/partest/PartestTask.scala)
2325
- sbt (http://github.com/scala/scala-partest-interface)
2426
- the [test/partest script](https://github.com/scala/scala/blob/2.11.x/test/partest), which uses ant to set up the classpath in the same way as the ant task, but then launches [ConsoleRunner](https://github.com/scala/scala-partest/blob/master/src/main/scala/scala/tools/partest/nest/ConsoleRunner.scala) directly.
25-
27+
2628
The compiler to be tested must be on the classpath.
2729
The corresponding jar or class directory is detected by [FileManager::findArtifact](https://github.com/scala/scala-partest/blob/master/src/main/scala/scala/tools/partest/nest/FileManager.scala#L123).
2830

2931
The classpath to run partest is specific to the compiler/libraries under test (script not included here, but see [the main test/partest script](https://github.com/scala/scala/blob/2.11.x/test/partest)).
3032
It must provide the scala compiler to be tested and all its dependencies, and of course a compatible version of partest.
3133
For details on the available arguments, see the [ConsoleRunner argument spec](https://github.com/scala/scala-partest/blob/master/src/main/scala/scala/tools/partest/nest/ConsoleRunnerSpec.scala).
3234
Here are some non-obvious useful options:
35+
3336
- `--failed`: run only failed tests (ones that have a log file)
3437
- `--update-check`: overwrite check files with log files (where the latter exists)
3538
- `-Dpartest.scalac_opts=...` -> add compiler options
3639
- `-Dpartest.debug=true` -> print debug messages
3740

3841
Advanced usage:
42+
3943
- tests may consist of multiple files (the test name is the directory's name),
4044
and files (including java sources) in that directory are compiled in order by looking
4145
at `_$N` suffixes before the file's extension and compiling them grouped by $N, in ascending order.
4246
- jars in `test/files/lib` are expected to be on the classpath and may be used by tests
4347
- certain kinds of tests (scalacheck/instrumented/specialized) add additional jars to the classpath
4448

4549
System properties available to tests:
50+
4651
- `partest.output`: output directory (where classfiles go)
4752
- `partest.lib`: the path of the library (jar or class dir) being tested
4853
- `partest.reflect`: the path of scala-reflect (jar or class dir) being tested

0 commit comments

Comments
 (0)