Skip to content
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.

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

Feat : Troubleshooting Page #379

Open
wants to merge 6 commits into
base: lean4
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions data/menus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- Online version (no installation): https://lean.math.hhu.de/
- Using Lake (build system): install/project.html
- The Lean toolchain: toolchain.html
- Troubleshoot: install/troubleshoot.html

- title: Documentation
items:
Expand Down
29 changes: 29 additions & 0 deletions templates/install/troubleshoot.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Troubleshooting Common Problems

In this page we document a set of common problems that users encounter when using their lean toolchain installation. It does not deal with issues that users may encounter with a proof or a language feature. This webpage is a constant Work in Progress. Users who are unable to find a solution to their problems on this page are encouraged to describe their problem on [Zulip](https://leanprover.zulipchat.com/)

### Lost your Infoview

You can get it back as follows
* On a PC or laptop which typically runs windows/linux press `Ctrl+Shift+Enter`
* On an apple machine press `Cmd+Shift+Enter`

### Get Access to Docs inside VSCode

You can get the Lean documentation inside VS Code using `Ctrl-Shift-p` (`Cmd-Shift-p` on MacOS) and then, inside the text field that appears, type `lean doc`` and hit Enter. You will be led to the documentation viewer on a side panel.

### Command Not Found Error on MacOS or Linux
If you encounter any command not found errors when opening a new terminal, try the following quick-fixes in order:
* If you are on macOS and have not tinkered with your shell you are most likely using a shell called `zsh`. Run the command `source ~/.zshrc` and try again.
* If you are on linux, currently the default shell in popular distributions like Ubuntu or Linux Mint is `bash`. In this case, run `source ~/.bashrc`.
* If this still doesn't work, logging out and logging in again should fix it.

### InitializeSecurityContext error on Windows
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having this information in two different places feels like a recipe for confusion to me.

Copy link
Author

@Shreyas4991 Shreyas4991 Oct 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could link to this paragraph from other pages. In such pages we have a section titled "Errors you might encounter" with links


Some Windows users have reported an error like this when running lake exe cache get:

> curl: (35) schannel: next InitializeSecurityContext failed: Unknown error (0x80092012) - The revocation function was unable to check revocation for the certificate

If you see this error, you likely have an antivirus program that scans each downloaded file, which results in errors. Please disable your antivirus program and then run lake exe cache get!. The exclamation mark forces lake to re-download the cache files it failed to download before running this command. (If you are uncomfortable disabling your antivirus, try to follow these instructions and then run lake exe cache get!). You can turn on your antivirus program on afterwards. However, some users also reported that the antivirus programs significantly slow down Lean during normal usage. If Lean is slower than what is expected, either turn off your antivirus program or tell it to ignore/allow the operation of lean.exe.