intel / intel/SDM

[Feature]: Include function signatures in operation elements

Open
#2 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
HTML
Stars
29
Forks
4
PR merge metrics
No merged PRs in 30d

Description

The operation elements publish `Instr_*` function bodies but not their parameter types or return types. The bodies use free variables whose types aren't stated, and the call sites in the iform code pass untyped expressions.

This is a large obstacle to turning the XML into a checkable codebase and impairs readability (the rendered operation code contains names whose types and widths are never stated).

Emitting the function header as part of the operation element would resolve this.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how operation elements publish the `Instr_*` function bodies and how the iform code supplies their call-site expressions. Determine how function headers can be emitted alongside those bodies. Done means each operation element includes parameter types and return types so free variables and call sites are explicitly typed.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, xml
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.