docs: init first sketch #294
Conversation
RaitoBezarius
force-pushed
the
proving-with-lean
branch
from
24ef51b
to
e340a84
Compare
RaitoBezarius
force-pushed
the
proving-with-lean
branch
3 times, most recently
from
2931670
to
be14c6a
Compare
|
PTAL @sonmarcho I dropped the irrelevant parts. |
RaitoBezarius
force-pushed
the
proving-with-lean
branch
from
be14c6a
to
234bf73
Compare
|
@sonmarcho In principle, I updated to 4.11.0-rc2 and confirmed it built on my system, let's see how it goes. |
This is a first sketch of user documentation for Aeneas to prove things with Lean. Signed-off-by: Ryan Lahfa <[email protected]>
Well, this is required… Following Loogle's steps, we add fake files for ProofWidgets4 and we can produce an .olean from Aeneas' base library without Lake involvement! Free parallelization and caching :). TODOs are to improve the hash handling when lake-manifest.json bumps, but this requires extending Lake to produce the NAR hash serializations. Signed-off-by: Ryan Lahfa <[email protected]>
I extracted a Factorial example in Rust to Lean. Signed-off-by: Ryan Lahfa <[email protected]>
As upstream is moving to a non-user-facing Nix library, we are vendoring some of the useful code such as `buildLeanPackage`. Signed-off-by: Ryan Lahfa <[email protected]>
Adds the TODO list for infrastructure. Signed-off-by: Ryan Lahfa <[email protected]>
Micro-guide for update:
- Update the Lean flake.
- Update all the sha256 hashes of every dependency if you have a
compilation error, e.g. batteries changed, etc.
The day where `inputs.lean.packages.${system}.deprecated` disappear, we
will need to consider an alternative for the nixpkgs from lean, etc.
Signed-off-by: Ryan Lahfa <[email protected]>
RaitoBezarius
force-pushed
the
proving-with-lean
branch
from
f6376df
to
3a1d6bc
Compare
|
@pnmadelaine |
|
This is great, thanks!! I will review and merge asap. |
docs/user/README.md
Outdated
|
|
||
| The Nix setup reads the `lakefile-manifest.json`, but this lockfile is insufficient to lock purely the dependencies (NAR SHA256 serialization are missing). | ||
|
|
||
| To overcome this, they are specified manually in `flake.nix`, but each time the Aeneas standard library updates their dependencies, the `flake.nix` needs to have all its hash rewritten. |
There was a problem hiding this comment.
I don't fully understand what we are supposed to do when updating the dependencies.
With regards to that, I guess adding some comments in the flake.nix would be useful?...
There was a problem hiding this comment.
I expanded much more the documentation, let me know how you feel about it now
| @@ -0,0 +1,190 @@ | |||
| var Alectryon; | |||
There was a problem hiding this comment.
This file also comes from Alectryon right? There are no copyrights (that's surprising)?
There was a problem hiding this comment.
Yep, but this is how it is upstream, I am fine with adding the compliance copyright, what do you prefer?
There was a problem hiding this comment.
(may be worth investigating https://reuse.software/ if we want to maximize the licensing compliance situation)
Signed-off-by: Ryan Lahfa <[email protected]>
RaitoBezarius
force-pushed
the
proving-with-lean
branch
from
3d22049
to
84f3e3f
Compare
I updated the docs, but there's a section on this. |
This is a first sketch of user documentation for Aeneas to prove things with Lean.
This adds a factorial example with Alectryon and scaffolding from the Lean original project.