search

mortbopet / Ripes

A graphical processor simulator and assembly editor for the RISC-V ISA
https://ripes.me/
MIT License
2.58k stars 274 forks source link

Elaborate documentation of file-related system calls #122

Open mortbopet opened 3 years ago

mortbopet commented 3 years ago

As described in #121, the system call menu help->system calls has lacking documentation for the usage and meaning of file-related system calls, such as open.

These descriptions should be elaborated, such as by including the semantics of the various flags for open: https://github.com/mortbopet/Ripes/blob/d692d719e60dd9e6f043be337dbfa003a20dcba8/src/syscall/systemio.h#L80-L86

i.e.

image

"Opens a file from a path" is pretty non-informative, and could easily also explain something about the flags.

Satarupa22-SD commented 1 year ago

@mortbopet I have added a PR on this issue. Could you please check and let me know if any additional changes are to be made. Thanks!