Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update systemio.h #291

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

Satarupa22-SD
Copy link

Elaborated descriptions as per issue #122

 Elaborated descriptions as per issue mortbopet#122
@mortbopet
Copy link
Owner

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
Copy link
Author

@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
Copy link
Owner

2nd argument here is the description that'll appear in the dialog

: BaseSyscall("Open", "Opens a file from a path",

@Satarupa22-SD
Copy link
Author

Satarupa22-SD commented Jul 27, 2023

@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
Copy link
Owner

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.

Added flag description.
@Satarupa22-SD
Copy link
Author

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

@Satarupa22-SD
Copy link
Author

@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
Copy link
Owner

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
Copy link
Author

Satarupa22-SD commented Sep 4, 2023

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

@Satarupa22-SD
Copy link
Author

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

@mortbopet
Copy link
Owner

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
Copy link
Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants