max/lean4-htt
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

doc: further elaborate on elan and Emacs setup

Browse source 
/cc @leodemoura @mhuisi
This commit is contained in:
Sebastian Ullrich 2020-05-18 11:00:29 +02:00
parent bb554930f8
commit ff0d56da65
2 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/make/index.md
View file

@ -148,8 +148,14 @@ yourself. A simple option for doing that is to use
[`elan`](https://github.com/Kha/elan), see the next section.
The only currently supported editor is Emacs, see `lean4-mode/README.md` for
basic setup. You can set `lean4-rootdir` manually to tell it what stage to use,
but `elan` again makes it simple to do that automatically.
basic setup. You can set `lean4-rootdir` manually to tell it what stage to use:
```
# while editing the Lean library
M-x set-variable lean4-rootdir RET ".../build/release/stage0" RET
# while testing, using a Lean that includes your changes
M-x set-variable lean4-rootdir RET ".../build/release/stage0.5" RET
```
but `elan` again makes it simple to do that automatically, see below.
Dev setup using elan
--------------------
@ -180,7 +186,9 @@ elan override set lean4-stage0
You can also use the `+toolchain` shorthand (e.g. `lean +lean4-debug`) to switch
toolchains on the spot. `lean4-mode` will automatically use the `lean` executable
associated with the directory of the current file as long as `lean4-rootdir` is
unset and `~/.elan/bin` is in your `exec-path`.
unset and `~/.elan/bin` is in your `exec-path`. Where Emacs sources the
`exec-path` from can be a bit unclear depending on your configuration, so
alternatively you can also set `lean4-rootdir` to `"~/.elan"` explicitly.
You might find that debugging through elan, e.g. via `gdb lean`, disables some
things like symbol autocompletion because at first only the elan proxy binary

2
lean4-mode/README.md
View file

@ -4,7 +4,7 @@ Installation
To use `lean4-mode` in Emacs, add the following to your `init.el`:
```
;; You need to modify the following line
(setq load-path (cons (concat lean4-rootdir "/path/to/lean4-mode") load-path))
(setq load-path (cons "/path/to/lean4/lean4-mode" load-path))
(setq lean4-mode-required-packages '(dash dash-functional f flycheck s))