Skip to content

Commit ceeb8b0

Browse files
author
davidcok
committed
Minor edits
1 parent bc80e2f commit ceeb8b0

File tree

4 files changed

+6
-6
lines changed

4 files changed

+6
-6
lines changed

tutorial/Execution.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ or paths relative to the current working directory
1313
* Options inherited from javac are unchanged. They are a mix of single-hyphen and double-hyphen spellings.
1414
* OpenJML-specific options begin with a double hyphen (e.g., `--quiet`) (single hyphens are still accepted for most options).
1515
Options that take a value either (a) have the value follow the option as the next argument or (b)
16-
(for OpenJML options, but only some Java option) use the syntax `-option=value`.
16+
(for OpenJML options, but only some Java option) use the syntax `--option=value`.
1717
For some options, the value may be a comma-separated list; if the value contains
1818
whitespace, it must be enclosed in quotes.
1919

2020
The details of all the options are given in the [OpenJML Users' Guide](../documentation/OpenJMLUserGuide.pdf). A few are worth mentioning here:
2121
* `--help` or `-?`: emit help information (about all of the options)
2222
* `--esc`: run static checking (the default is just parse and type-checking)
23-
* `--rac`: run runtime-assertion-checking
23+
* `--rac`: compile with embedded checks, for runtime-assertion-checking
2424
* `--progress`: emits more information during processing than the default `--normal`
2525

2626
Use `--class-path` or `-cp` just as you would for `javac` to specify the list of folders on which to find files. `openjml` uses a classpath and a sourcepath exactly like `javac` does; in addition `openjml` considers a _specspath_ for finding specification files. For most applications, it is simplest to define a single classpath (using the `-cp` command-line option or the `CLASSPATH` environment variable) giving the jar files and folder roots of package hierarchies for all the class, source and specification files. The details are an advanced topic presented [here](SpecificationFiles).

tutorial/Installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ title: JML Tutorial - Installation
44

55
Installation of OpenJML is simple:
66

7-
* Download the current release (in the 17.* or higher series, not the 8.* series) from [here](https://github.com/OpenJML/OpenJML/releases/latest)
7+
* Download the current release (in the 21.* or higher series) from [here](https://github.com/OpenJML/OpenJML/releases/latest).
88
* Unzip the downloaded .zip file in a clean folder. The location and name of the directory are up to the user (though spaces in the folder name or path are not permitted).
99
* The executable is the script named `openjml` in the top-level of the
1010
installation. Do not move or rename this file, but you may make a link to the
1111
file or place it on your system PATH.
12-
* On a mac you may need to run `mac-setup` to enable permissions for the downloaded executables. You may also need to install `realpath` (for example, using `brew install coreutils`), so that symbolic links can be resolved (you only need this if you make a symbolic link to openjml or other executables in the installation.)
12+
* On a Mac you may need to run `mac-setup` to enable permissions for the downloaded executables. You may also need to install `realpath` (for example, using `brew install coreutils`), so that symbolic links can be resolved (you only need this if you make a symbolic link to openjml or other executables in the installation.)
1313
* OpenJML is a modified version of the OpenJDK `javac`. It is a standalone,
1414
encapsulated executable; no installation of Java is needed to run it.
1515

tutorial/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ We know you are eager to just try out some code, but here is a quick set of bull
1111
The tutorial is mostly focussed on DV/ESC (though there are lessons on RAC as well):
1212
* The DV approach is akin to logically symbolically executing a method for every possible legal set of inputs (every possible pre-state)
1313
* So when the method verifications are successful, the result is a more powerful statement of correctness than is testing/RAC
14-
* Each method is checked on its own, using the specifications (not the implementations) of the other methods.
14+
* Each method is checked on its own, using the specifications (not the implementations) of the other methods
1515
* This is a valid approach so long as, eventually, all methods verify successfully (and it can be proved that the program terminates)
1616

1717
The tutorial walks you through basic JML, with plenty of examples that you can execute using OpenJML.

tutorial/Syntax.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ if
9393
So positive keys enable a comment and negative keys disable it, with any
9494
negative key overriding any positive ones.
9595

96-
For example, a comment beginning `//-RAC@` will be used for typechecking (--check) and static checking (--esc), but ignored for runtime checking (--rac). A comment beginning `//+ESC@` will only be used when `-esc` is being applied.
96+
For example, a comment beginning `//-RAC@` will be used for typechecking (`--check`) and static checking (`--esc`), but ignored for runtime checking (`--rac`). A comment beginning `//+ESC@` will only be used when `-esc` is being applied.
9797
The most common use of conditional JML annotations is the first example: to turn off
9898
non-executable annotations during runtime-assertion checking but leave
9999
them in place for static checking.

0 commit comments

Comments
 (0)