doc-gen icon indicating copy to clipboard operation
doc-gen copied to clipboard

README: clarify line about .olean files

Open waldyrious opened this issue 4 years ago • 3 comments

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?

waldyrious avatar Apr 10 '21 15:04 waldyrious

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

bryangingechen avatar Apr 10 '21 16:04 bryangingechen

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.

bryangingechen avatar Apr 10 '21 16:04 bryangingechen

Which easily takes 2 hours.

jcommelin avatar Apr 10 '21 17:04 jcommelin