Skip to content

Enhance README with hacking and troubleshooting info #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
srghma wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance README with hacking and troubleshooting info #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,31 @@ Type **"auto 👍"** to test whether auto is set up.
* ``cvc5``
* ``zipperposition`` portfolio mode

## Hacking

### Building native `.so` plugins (`:dynlib`)

Lean-auto builds a number of native dynamic libraries (`:dynlib` targets).
During `lake build` you may see errors like:

```
collect2: fatal error: cannot find ‘ld’
compilation terminated.
error: external command 'gcc' exited with code 1
```

This means that the system linker (`ld`) is missing from your environment.

#### Fix on Nix/NixOS

On nixos `nix profile add nixpkgs#gcc nixpkgs#binutils` doesnt work. Use instead

```bash
nix profile add nixpkgs#llvmPackages.bintools
```

After that, `lake build` should succeed.

## Troubleshooting
* ``Monomorphization failed because ...``:
Try adding `set_option auto.mono.ignoreNonQuasiHigherOrder true` before you invoke `auto`
Expand Down Expand Up @@ -109,4 +134,4 @@ Type **"auto 👍"** to test whether auto is set up.
* `ciInstDefEq`: Definitional equality resulting from instance relations between ``ConstInst``s
* `termLikeDefEq`: Definitional equality resulting from definitional equalities between term-like subexpressions
* `❰<term>❱`: User-provided lemma `<term>`
* `queryNative::<func_name>`: Proved by native prover
* `queryNative::<func_name>`: Proved by native prover