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

README: clarify line about .olean files #129

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

Conversation

waldyrious
Copy link

Just a small tweak to make the line less cryptic for beginners.

Although, to be honest I still don't fully understand what this sentence is saying — how does one make sure the .olean files are generated in the _target folder, and what exactly will be extremely slow otherwise?

@bryangingechen
Copy link
Collaborator

bryangingechen commented Apr 10, 2021

I usually run leanproject up to update the project to depend on the latest mathlib master, or simply leanproject get-mathlib-cache if I don't care what version of mathlib I'm generating the docs for.

See https://leanprover-community.github.io/leanproject.html#getting-mathlib-oleans

@@ -15,7 +15,8 @@ rm -rf _target
leanproject up
```

Make sure that olean files are generated for mathlib in `_target`, otherwise this will be extremely slow.
Make sure that [`.olean` files](https://github.com/leanprover/tutorial/blob/master/05_Interacting_with_Lean.org#projects)
Copy link
Collaborator

Choose a reason for hiding this comment

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

We most likely don't want to link to that tutorial which is very out of date. It's better to link to the community webpage on leanproject.

Copy link
Author

Choose a reason for hiding this comment

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

Sure, I can remove the link — just changing from "olean files" to ".olean files" already helps making things a little clearer, IMO. I could replace the link with https://leanprover-community.github.io/leanproject.html instead, but I don't think that page (in its current state) provides the information one would expect when clicking on the expression ".olean files" (i.e. additional details on what .olean files are).

That said, depending on the outcome of the conversation at leanprover-community/leanprover-community.github.io#180, it could make sense to add the link here. I'd suggest holding this PR until that one is resolved, so we can decide what makes the most sense here.

@bryangingechen
Copy link
Collaborator

what exactly will be extremely slow otherwise?

If the .olean files are not present, generating the docs will take a long time since Lean will have to compile all of mathlib from scratch.

@jcommelin
Copy link
Member

Which easily takes 2 hours.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants