search

mortbopet / Ripes

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

Update systemio.h #291

Open Satarupa22-SD opened 1 year ago

Satarupa22-SD commented 1 year ago

Elaborated descriptions as per issue #122

mortbopet commented 1 year ago

Thank you for taking a stab at the issue! I've updated the issue slightly to better reflect what I'd hope to see wrt. better documentation - tl;dr it's concerning the info that's displayed when you open the system call menu.

Satarupa22-SD commented 1 year ago

@mortbopet Description: The open system call is used to open files in the file system. It allows you to create new files or open existing ones for reading, writing, or both. The call returns a file descriptor that represents the opened file, which is later used for performing various operations on the file. we can also include syntax, parameters(path and flags) and modify the return value to further improve the current documentation.

However could you please share the file location where the changes need to be made. I have not been able to find it . Thanks!

mortbopet commented 1 year ago

2nd argument here is the description that'll appear in the dialog https://github.com/mortbopet/Ripes/blob/c36b9c76feffd2a015654956842b0e0fd26486b0/src/syscall/file.h#L17

Satarupa22-SD commented 1 year ago

@mortbopet I have made the changes to file.h. Please let me know if any additional changes are to be made. Also, thanks a lot for guiding me.

mortbopet commented 1 year ago

Great, thanks! I think the description should also include information about the different flags that the user can provide as argument - that, or just point to a link describing these since i assume it's documented somewhere in the RISC-V ABI.

Satarupa22-SD commented 1 year ago

@mortbopet I have updated the flag description. Please check and let me know if any modifications are needed.

Satarupa22-SD commented 1 year ago

@mortbopet has the build failed due to the flag description which I have added? Is there any documentation/resource I can look into to fix this issue. I am still a beginner in open source and I would really appreciate your guidance.

mortbopet commented 1 year ago

has the build failed due to the flag description which I have added?

Correct - make sure that the application is able to build successfully locally; looks like this is an issue with addFlagDescription not being declared anywhere.

Satarupa22-SD commented 1 year ago

@mortbopet has this issue been reassigned? I was busy with University stuff hence was off GitHub for a few days.

Satarupa22-SD commented 1 year ago

Also when can we expect to hear about the status of our LFX mentorship application.

mortbopet commented 1 year ago

The issue in question is that there's an issue in the code you submitted, where addFlagDescription is not being declared anywhere - so you need to fix that.

Satarupa22-SD commented 1 year ago

@mortbopet I will start working on it then. Thanks!