Merge pull request #486 from sosy-lab/feat/spell-check-and-style

Spell check and style improvements

Author: kfriedberger

CHANGELOG.md

@@ -158,7 +158,7 @@ The visitation of quantified formulas was improved.
 ## JavaSMT 3.9.0
 
 This release contains a larger update of Princess and more JUnit tests.
-The PrettyPrinter is switched from a boolean parameter to a options enum.
+The PrettyPrinter is switched from a boolean parameter to an options enum.
 The example projects for Maven are updated with newer solver versions.
 
 ### Updated solvers:
@@ -181,7 +181,7 @@ if disk space is a critical point.
 
 ### Updated solvers:
  - MathSAT5 5.6.5 (inculding binary for Windows)
- - Z3 4.8.9 (including binaries for Windows and MacOS)
+ - Z3 4.8.9 (including binaries for Windows and macOS)
 
 ## JavaSMT 3.6.1
 

README.md

@@ -76,7 +76,7 @@ JavaSMT supports several SMT solvers (see [Getting Started](doc/Getting-started.
 
 We support a reasonable list of operating systems and versions.
 - Our main target is Linux (mainly Ubuntu or comparable Linux distributions).
-  Windows 10/11 and MacOS are supported for several SMT solvers.
+  Windows 10/11 and macOS are supported for several SMT solvers.
 - Our main development architecture is x64 (x86-64).
   We also provide some solvers for ARM64 (AArch64 for ARMv8-A), e.g., Java-based SMT solvers, Z3, and MathSAT.
   If a specific operating system or architecture is missing and required,
@@ -88,7 +88,7 @@ available with Ubuntu 18.04 or later.
 
 ² Solver requires at least `GLIBC_2.29`/`GLIBCXX_3.4.26` or `GLIBC_2.34`/`GLIBCXX_3.4.29`,
 available with Ubuntu 22.04 or later.  
-³ We do not provide a signed solver library for MacOS. The user needs to compile and sign it.
+³ We do not provide a signed solver library for macOS. The user needs to compile and sign it.
 
 #### Solver Features
 

build/build-compile.xml

@@ -74,7 +74,7 @@ SPDX-License-Identifier: Apache-2.0
             <src path="${source.dir}"/>
             <classpath refid="classpath"/>
             <compilerarg value="-Xlint"/>
-            <compilerarg value="-Xlint:-fallthrough"/> <!-- checked by error-prone, too, and javac does not recognized $FALL-THROUGH$ -->
+            <compilerarg value="-Xlint:-fallthrough"/> <!-- checked by error-prone, too, and javac does not recognize $FALL-THROUGH$ -->
             <compilerarg value="-Xlint:-processing"/>
             <compilerarg value="-Xlint:-options"/> <!-- suppress warning about bootclasspath on newer JDK -->
             <compilerarg value="-Xlint:-this-escape" if:set="java21"/> <!-- false alarm for every use of configuration injection -->

build/build-documentation.xml

@@ -37,7 +37,7 @@ SPDX-License-Identifier: Apache-2.0
 
             <classpath refid="classpath"/>
 
-            <!-- "-v" is a optional param for verbose output of OptionCollector -->
+            <!-- "-v" is an optional param for verbose output of OptionCollector -->
             <!-- <arg value="-v"/> -->
         </java>
         <echo message="Options collected." level="info"/>

build/build-ivy.xml

@@ -46,7 +46,7 @@ SPDX-License-Identifier: Apache-2.0
     </condition>
     <property name="ivy.cache.dir" location="${tmp.ivy.cache.dir}" />
 
-    <!-- If necessary, download Ivy from web site so that it does not need to be installed. -->
+    <!-- If necessary, download Ivy from website so that it does not need to be installed. -->
     <target name="bootstrap-ivy" unless="ivy.jar.present">
         <mkdir dir="${ivy.jar.dir}"/>
         <echo message="Downloading ivy..."/>

build/build-maven-publish.xml

@@ -48,7 +48,7 @@ SPDX-License-Identifier: Apache-2.0
     </target>
 
     <!-- macro for pushing a JavaSMT file into a Maven repository
-         (push into the staging area, from there manual publication is required afterwards) -->
+         (push into the staging area, from there manual publication is required afterward) -->
     <macrodef name="stage-javasmt-file">
       <attribute name="filename"/>
       <attribute name="fileending"/>
@@ -82,7 +82,7 @@ SPDX-License-Identifier: Apache-2.0
     </macrodef>
 
     <!-- macro for pushing solvers into a Maven repository
-         (push into the staging area, from there manual publication is required afterwards) -->
+         (push into the staging area, from there manual publication is required afterward) -->
     <macrodef name="stage-solver-file">
       <!-- 'filename' is only used for reading file from file-system, not used "in" Maven -->
       <attribute name="filename"/>

build/build-publish-solvers/solver-bitwuzla.xml

@@ -44,7 +44,7 @@ SPDX-License-Identifier: Apache-2.0
             The script will append the git revision.
         </fail>
         <fail unless="bitwuzla.rebuildWrapper">
-            Please specify if the Bitwuzla wrapper should be rebuild with the flag
+            Please specify if the Bitwuzla wrapper should be rebuilt with the flag
             -Dbitwuzla.rebuildWrapper=BOOL. Rebuilding the wrapper is necessary if the Bitwuzla API
             has changed since the last release, but requires the SWIG tool to be installed on
             this machine.
@@ -376,7 +376,7 @@ SPDX-License-Identifier: Apache-2.0
         -->
         <echo>
             Lets copy the files for architecture x64 into main directory, for backwards compatibility.
-            Afterwards, please execute the SVN command from above.
+            Afterward, please execute the SVN command from above.
         </echo>
         <copy todir="repository/${ivy.organisation}/${ivy.module}/" verbose="true">
             <fileset dir="repository/${ivy.organisation}/${ivy.module}/x64/">

build/build-publish-solvers/solver-mathsat.xml

@@ -87,7 +87,7 @@ SPDX-License-Identifier: Apache-2.0
         -->
         <echo>
             Lets copy the files for architecture x64 into main directory, for backwards compatibility.
-            Afterwards, please execute the SVN command from above.
+            Afterward, please execute the SVN command from above.
         </echo>
         <copy todir="repository/${ivy.organisation}/${ivy.module}/" verbose="true">
             <fileset dir="repository/${ivy.organisation}/${ivy.module}/x64/">

build/build-publish-solvers/solver-z3.xml

@@ -24,7 +24,7 @@ SPDX-License-Identifier: Apache-2.0
             INFO
             Please specify the path to Z3 sources directory with the flag '-Dz3.path=/path/to/z3/z3-unpacked-sources'.
             The path should contain directories like './src/' and './scripts/', and can be relative or absolute.
-            Please provide all unpacked releases (Linux, MacOS, and Windows for x64 and arm64
+            Please provide all unpacked releases (Linux, macOS, and Windows for x64 and arm64
             architecture) in the same parent directory './../' above the 'z3.path'.
             This script does not expect other z3-related files or directories in the parent directory.
             For example, the directory structure can look like this:
@@ -39,7 +39,7 @@ SPDX-License-Identifier: Apache-2.0
              |-- z3-z3-4.13.2/                  // <-- sources directory as 'z3.path'
 
             This can be achieved by:
-            - download all artifacts (Linux, MacOS, and Windows for x64 and arm64 architecture)
+            - download all artifacts (Linux, macOS, and Windows for x64 and arm64 architecture)
               from the Z3 release webpage (https://github.com/Z3Prover/z3/releases)
             - create an empty directory 'z3/' and unpack all artifact into it.
             - in the sources directory execute `python scripts/mk_make.py --java` to generate all
@@ -121,7 +121,7 @@ SPDX-License-Identifier: Apache-2.0
         -->
         <echo>
             Lets copy the files for architecture x64 into main directory, for backwards compatibility.
-            Afterwards, please execute the SVN command from above.
+            Afterward, please execute the SVN command from above.
         </echo>
         <copy todir="repository/${ivy.organisation}/${ivy.module}/" verbose="true">
             <fileset dir="repository/${ivy.organisation}/${ivy.module}/x64/">
@@ -155,7 +155,7 @@ SPDX-License-Identifier: Apache-2.0
         <!-- cleanup -->
         <delete dir="${z3.javadoc.dir}" quiet="true"/>
         <!-- then write new files.
-             Lets ignore minor issues, e.g. using html tag <tt> instead of <code> -->
+             Let's ignore minor issues, e.g. using html tag <tt> instead of <code> -->
         <javadoc
             destdir="${z3.javadoc.dir}"
             classpathref="classpath"

doc/Developers-How-to-Release-into-Ivy.md

@@ -64,7 +64,7 @@ z3/                                 // <-- parent directory
 ```
 
 You can prepare the Z3 Java sources on an arbitrary system, as we only prepare 
-Java sources and JavaDoc for the bindings, but do no compile any native library.
+Java sources and JavaDoc for the bindings, but do not compile any native library.
 This only depends on a Python3 environment and Java 17 or later.
 For simple usage, we provide a Docker definition/environment under `/docker`, in which the following command can be run.
 
@@ -84,14 +84,14 @@ Finally, follow the instructions shown in the message at the end.
 #### Optional (from source for Linux target with older GLIBC)
 This step is for the following use case:
 Newer releases of Z3 depend on newer versions of GLIBC (>=v2.35),
-so we want to compile the Linux release on our own and then combine it with the provided libraries for Windows and MacOS.
+so we want to compile the Linux release on our own and then combine it with the provided libraries for Windows and macOS.
 We follow the steps from above, download and unpack the given zip archives for all platforms, except the Linux release (where the GLIBC is too new).
 For simple usage, we provide a Docker definition/environment under `/docker` (based on Ubuntu 18.04 with GLIBC 2.27),
 in which the following build command can be run in the unpacked source directory:
 ```
 python3 scripts/mk_make.py --java && cd build && make -j 2
 ```
-Afterwards copy the native libraries for Linux (`libz3.so` and `libz3java.so`) from the directory 
+Afterward, copy the native libraries for Linux (`libz3.so` and `libz3java.so`) from the directory 
 `./build` into `./bin` (if needed, adjust the directory to match the x64 or arm64 path for Linux).
 Then perform as written above with adding the additional pre-compiled binaries for other operating systems,
 and publish the directory `./bin` with an ant command like the one from above:
@@ -349,7 +349,7 @@ Publish the solver binary from within JavaSMT (adjust all paths to your system!)
 ant publish-yices2 -Dyices2.path=../solvers/yices2 -Dgmp.path=../solvers/gmp-6.2.0 -Dgperf.path=../solvers/gperf-3.1 -Dyices2.version=2.6.2-89-g0f77dc4b
 ```
 
-Afterwards you need to update the version number in `solvers_ivy_conf/ivy_javasmt_yices2.xml` and publish new Java components for Yices2.
+Afterward, you need to update the version number in `solvers_ivy_conf/ivy_javasmt_yices2.xml` and publish new Java components for Yices2.
 
 #### Publish the Java components for Yices2