Various documentation fixes (#224)

* typos * Set Version: 0.1.80 * fix KVersion warning * add cheatcodes.md disclaimer * gracefully shut down when forge is not in PATH --------- Co-authored-by: devops <[email protected]>
runtimeverification · Dec 4, 2023 · 70fcc97 · 70fcc97
1 parent 08303c4
commit 70fcc97
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -30,17 +30,17 @@ poetry install
 
 In order to build `kontrol`, you need to build these specific targets:
 ```sh
-poetry run kdist --verbose build -j3 evm-semantics.haskell kontrol.foundry
+poetry run kdist --verbose build -j2 evm-semantics.haskell kontrol.foundry
 ```
 
 To change the default compiler:
 ```sh
-CXX=clang++-14 poetry run kdist --verbose build -j3 evm-semantics.haskell kontrol.foundry
+CXX=clang++-14 poetry run kdist --verbose build -j2 evm-semantics.haskell kontrol.foundry
 ```
 
 On Apple Silicon:
 ```sh
-APPLE_SILICON=true poetry run kdist --verbose build -j3 evm-semantics.haskell kontrol.foundry
+APPLE_SILICON=true poetry run kdist --verbose build -j2 evm-semantics.haskell kontrol.foundry
 ```
 
 Targets can be cleaned with:

diff --git a/package/version b/package/version
@@ -1 +1 @@
-0.1.79
+0.1.80
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "kontrol"
-version = "0.1.79"
+version = "0.1.80"
 description = "Foundry integration for KEVM"
 authors = [
     "Runtime Verification, Inc. <[email protected]>",

diff --git a/src/kontrol/__init__.py b/src/kontrol/__init__.py
@@ -5,4 +5,4 @@
 if TYPE_CHECKING:
     from typing import Final
 
-VERSION: Final = '0.1.79'
+VERSION: Final = '0.1.80'
diff --git a/src/kontrol/__main__.py b/src/kontrol/__main__.py
@@ -92,7 +92,9 @@ def _check_k_version() -> None:
     actual_k_version = k_version()
 
     if not _compare_versions(expected_k_version, actual_k_version):
-        _LOGGER.warning(f'K version {expected_k_version} was expected but K version {actual_k_version} is being used.')
+        _LOGGER.warning(
+            f'K version {expected_k_version.text} was expected but K version {actual_k_version.text} is being used.'
+        )
 
 
 def _compare_versions(ver1: KVersion, ver2: KVersion) -> bool:

diff --git a/src/kontrol/foundry.py b/src/kontrol/foundry.py
@@ -229,6 +229,9 @@ def custom_view(self, contract_name: str, element: KCFGElem) -> Iterable[str]:
     def build(self) -> None:
         try:
             run_process(['forge', 'build', '--root', str(self._root)], logger=_LOGGER)
+        except FileNotFoundError:
+            print("Error: 'forge' command not found. Please ensure that 'forge' is installed and added to your PATH.")
+            sys.exit(1)
         except CalledProcessError as err:
             raise RuntimeError("Couldn't forge build!") from err
 
@@ -347,7 +350,7 @@ def help_info() -> list[str]:
             res_lines.append('')
             res_lines.append('See `foundry_success` predicate for more information:')
             res_lines.append(
-                'https://github.com/runtimeverification/evm-semantics/blob/master/include/kframework/foundry.md#foundry-success-predicate'
+                'https://github.com/runtimeverification/kontrol/blob/master/src/kontrol/kdist/foundry.md#foundry-success-predicate'
             )
         res_lines.append('')
         res_lines.append(

diff --git a/src/kontrol/kdist/cheatcodes.md b/src/kontrol/kdist/cheatcodes.md
@@ -1,5 +1,6 @@
-Foundry Cheat Codes
+Kontrol Cheat Codes
 -------------------
+This file contains the implementation of both Foundry and proprietary cheat codes supported by Kontrol.
 
 The configuration of the Foundry Cheat Codes is defined as follwing:
 1. The `<prank>` subconfiguration stores values which are used during the execution of any kind of `prank` cheat code: