Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve the documentation for the guest_dispatch_function in the C and Rust Guest APIs #197

Open
simongdavies opened this issue Jan 29, 2025 · 0 comments
Labels
area/documentation Related to documentation lifecycle/confirmed Bug is verified or proposal seems reasonable
Milestone

Comments

@simongdavies
Copy link
Contributor

The hyperlight guest library defines a function called guest_dispatch_function which allows the guest to dynamically dispatch calls to functions, this function is not really documented anywhere. We should document this function more clearly explaining its purpose and how to use it.

More generally we should improve this documentation to describe how to build a guest.

@simongdavies simongdavies added the area/documentation Related to documentation label Jan 29, 2025
@github-actions github-actions bot added the lifecycle/needs-review The issue has not yet been reviewed. label Jan 29, 2025
@syntactically syntactically added lifecycle/confirmed Bug is verified or proposal seems reasonable and removed lifecycle/needs-review The issue has not yet been reviewed. labels Feb 5, 2025
@danbugs danbugs added this to the Backlog milestone Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Related to documentation lifecycle/confirmed Bug is verified or proposal seems reasonable
Projects
Status: No status
Development

No branches or pull requests

3 participants