emscripten-core / emscripten-core/emscripten

Documentation about Module.arguments may need to be improved

Abierto
#21,082 3 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
C++
Estrellas
27.6k
Forks
3.6k
Merge medio
1 d 14 h
PR fusionados (30 d)
125

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Abre la documentación enlazada de Module API y lee la sección sobre cómo afectar a la ejecución; después, compara su descripción con los ejemplos de prejs de este issue. Se considera terminado cuando la documentación explica claramente que Module.arguments debe inicializarse antes de usarse, incluyendo un ejemplo adecuado.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
wasm
Área
documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
Menos de una hora
Estado de actividad
Estancado
Claridad
Bien especificado
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.