WebAssembly / WebAssembly/tool-conventions
Error in WASM_INIT_FUNCS docs
Nobody has claimed this yet.
- Dominant language
- WebAssembly
- Stars
- 372
- Forks
- 75
- PR merge metrics
- No merged PRs in 30d
Description
Hey. The WASM_INIT_FUNCS linker subsection is documented as being a count and then a 'sequence of symbol indices'. However, the latest implementation of wasm-lld reads pairs of varuint32s; the first as a priority, the second the symbol index, here.
I think this came from this which describes such a schema.
It means that if you follow this spec, the linker will reject you, so I take it this is an error in this doc?
Contributor guide
No contributing guide indexed for this repository
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 locating the WASM_INIT_FUNCS linker subsection in this repository's documentation, then compare its description with llvm/lib/Object/WasmObjectFile.cpp around line 436 and the linked WebAssembly tool-conventions issue. Confirm whether the format is pairs of priority and symbol-index varuint32s; done means the subsection accurately documents the implementation or the discrepancy is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- wasm
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100