RFC: Warn reverse FFI users who do not call `lean_setup_args`
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 9.2k
- Forks
- 990
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 175
Description
Proposal
#8636 adds a new lean_setup_args function which must be called by Reverse FFI users in order for some process information functions (specifically Std.Internal.IO.Process.getProcessTitle and Std.Internal.IO.Process.setProcessTitle) to work correctly. We should find a nice way to let Reverse FFI users know the protocol has changed so that they can adapt their code in their own time.
See https://github.com/leanprover/lean4/pull/8636#discussion_r2171536817
Impact
Add 👍 to issues you consider important. If others benefit from the changes in this proposal being added, please ask them to add 👍 to it.
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 by reading #8636 and the linked discussion to understand the new reverse FFI protocol and the requirement to call lean_setup_args. Inspect how Reverse FFI users currently interact with Std.Internal.IO.Process.getProcessTitle and setProcessTitle. Done means establishing and documenting an agreed warning mechanism that alerts affected users before they rely on the changed protocol.
Written by the indexing model from the issue text.
Assessment
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100