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.

Sign up for GitHub

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

Jump to bottom

Write Documentation #1

Open
yashrajkakkad opened this issue Oct 24, 2021 · 5 comments
Open

Write Documentation #1

yashrajkakkad opened this issue Oct 24, 2021 · 5 comments

Comments

@yashrajkakkad
Copy link

It would be helpful for interested contributors if kerla has some documentation. I would like to help with that. It will also help me understand kerla (and Operating Systems in general) better so that I can contribute with some code later on.

@nuta if possible can you suggest a rough outline of how you imagine the documentation to be structured? I can start working and send in some pull requests.
@nuta
Copy link
Owner

nuta commented Oct 24, 2021

Thanks @yashrajkakkad! I'll prepare the outline using mdbook.

@castarco
Copy link
Contributor

castarco commented Oct 28, 2021 •
edited
Loading

On that line, a document that is already there but might deserve some love is https://github.com/nuta/kerla/blob/main/COMPATIBILITY.md . All syscalls are marked as unimplemented, but as far as I know from what I read in the blog post, some of them are already available.

It would help to know what's there and what's not for others to contribute :) .

P.S.: Really cool work!
P.S. (2): Not too much stuff, but I already started with it:

nuta pushed a commit that referenced this issue Oct 28, 2021
@Daasin
Compromise license patch 1 (#13)
3d23db1 
* Proposed compromise amendment to license file:

(Change "and" to "and/or" in response to discussions in issue #5 #5 )

* Final Version of proposal for review in Issue #5 (#1)

Inc changes from prev commit:
https://github.com/Daasin/kerla/commit/c8df66ec48be5f3dff259db6023b99db3df0d01f
@yashrajkakkad
Copy link
Author

yashrajkakkad commented Nov 1, 2021 •
edited
Loading

@nuta @castarco Any ideas on what I can contribute to further in the docs?

Also @nuta thanks for preparing the outline!

For a start, I thought maybe I can write some details about what has been implemented for the system calls which are labelled as "Partially" implemented in the notes column.

nuta added a commit that referenced this issue Nov 4, 2021
@nuta
Embed a backtrace into Error in debug build
72554b4 
It helps where an error is constructed:

[   0.585] [7:curl] syscall: close(ffffffffffffffff, 0, 0, 0, 0, 0)
[   0.585] WARN: close: error: EBADF: This error originates from:
    #1: ffff800000184219  kerla::printk::capture_backtrace()+0x79
    #2: ffff8000001dbb13  kerla::result::Error::new()+0x23
    #3: ffff8000001dc0e7  <kerla::result::Error as c...la::result::Errno>>::from()+0x17
    #4: ffff800000211177  <T as core::convert::Into<U>>::into()+0x17
    #5: ffff8000001fcb55  kerla::fs::opened_file::OpenedFileTable::close()+0xa5
    #6: ffff80000010b124  kerla::syscalls::close::<i...yscallHandler>::sys_close()+0xa4
    #7: ffff80000011bf62  kerla::syscalls::SyscallHandler::do_dispatch()+0x4e62
    #8: ffff8000001168fc  kerla::syscalls::SyscallHandler::dispatch()+0x1ac
@castarco
Copy link
Contributor

castarco commented Nov 5, 2021

@yashrajkakkad I'm just an outsider, but what you said about improving information detail about syscalls seems like a good way to go. The current documentation is not entirely clear about what's missing when it comes to the partial implementations, as you said.

@nuta
Copy link
Owner

nuta commented Nov 7, 2021

Wrote the architecture page: https://kerla.dev/docs/architecture.html

Please let me know if you have any ideas on other pages. I'll write them :)

@UZER0 UZER0 mentioned this issue Nov 11, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@castarco @nuta @yashrajkakkad