emscripten-core / emscripten-core/emscripten

Documentation about Module.arguments may need to be improved

Aperta
#21,082 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
C++
Stelle
27.6k
Fork
3.6k
Merge medio
1g 14h
PR unite (30g)
125

Descrizione

The current documentation about `Module.arguments` is not clear enough, see [doc](https://emscripten.org/docs/api_reference/module.html#affecting-execution). You will receive "undefined" if you use `Module.arguments` straight in prejs because the documentation doesn't indicate that you should initialize it first, for example:
```
Module['arguments'].push("-k");
Module['arguments'].push("Image");
Module['arguments'].push("-b");
Module['arguments'].push("minimal.dtb");
Module['arguments'].push("-i");
Module['arguments'].push("rootfs.cpio");
```

Initializing `Module.arguments` before utilizing it in prejs is the proper usage procedure:
```
Module['arguments'] = []
Module['arguments'].push("-k");
Module['arguments'].push("Image");
Module['arguments'].push("-b");
Module['arguments'].push("minimal.dtb");
Module['arguments'].push("-i");
Module['arguments'].push("rootfs.cpio");
```

Related to: #11239

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Apri la documentazione collegata di Module API e leggi la sezione relativa all'influenza sull'esecuzione, quindi confronta la descrizione con gli esempi di prejs in questa issue. Il lavoro è completato quando la documentazione spiega chiaramente che Module.arguments deve essere inizializzato prima di essere utilizzato, includendo un esempio appropriato.

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

Valutazione

Stack tecnologico
wasm
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.