leanprover / leanprover/reference-manual
`lake exe generate-manual` does not work with `brew` installed `elan`
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
lake exe generate-manual does not work with brew installed elan:
✖ [469/477] Building Manual.BuildTools.Elan
error: reference-manual/Manual/BuildTools/Elan.lean:226:0: Mismatched 'elan --help' output output:
- elan-default
+ elan-default
Set the default toolchain
USAGE:
elan default <toolchain>
FLAGS:
-h, --help Prints help information
ARGS:
- <toolchain> Toolchain name, such as 'stable', 'nightly', or '3.3.0'. For more information see `elan help
- toolchain`
+ <toolchain> Toolchain name, such as 'stable', 'beta', 'nightly', or '4.3.0'. For more information see `elan
+ help toolchain`
Is there some way to instruct lake exe generate-manual to ignore any mismatched elan --help output, use an in-tree "local" copy of elan (not the brew installed one), or otherwise work around this issue?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with reference-manual/Manual/BuildTools/Elan.lean around line 226 and reproduce the failure using lake exe generate-manual with the brew-installed elan. Determine whether the command can complete despite the shown elan --help mismatch or whether the manual build needs a documented local-tool workaround; done means the manual generation no longer fails for this setup.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100