hyperlight-dev / hyperlight-dev/hyperlight

Improve the documentation for the `guest_dispatch_function` in the C and Rust Guest APIs

Aperta
#197 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area/documentation lifecycle/confirmed
Lingua principale
Rust
Stelle
4.7k
Fork
208
Merge medio
1g 7h
PR unite (30g)
48

Descrizione

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](https://github.com/hyperlight-dev/hyperlight/blob/main/docs/how-to-build-a-hyperlight-guest-binary.md) documentation to describe how to build a guest.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da docs/how-to-build-a-hyperlight-guest-binary.md e individua le definizioni di guest_dispatch_function nelle Guest API C e Rust. Leggi il contesto dell'API circostante e le istruzioni esistenti per la compilazione di un guest, quindi documenta lo scopo e l'utilizzo della funzione e fai in modo che la guida alla compilazione descriva come compilare un guest.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
c, rust
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.