libsel4camkes: Add markdown documentation #82
Conversation
|
Incomplete is a lot better than completely absent, so I'm all for that. Let me know if you need help with converting the license headers to SPDX. |
Thanks, seems I didn't push the changes I had already made for that. |
|
Since this is all documentation, the license for it should be |
|
nice work! |
| other components. | ||
| * The maximum number of virtqueues a component can register is defined by `MAX_CAMKES_VIRTQUEUE_ID` | ||
| The functions exposed by this library can be found in the `include` folder. | ||
| There is also more in-depth documentation inside the `docs` folder. |
There was a problem hiding this comment.
Give a summary here, plus any global caveats.
There was a problem hiding this comment.
That would be a good addition, but I think it is already useful without. Would add an issue for this.
libsel4camkes/docs/dma.md
Outdated
| CAmkES allocates and manages. These functions are essentially an implementation | ||
| of the `ps_dma_man_t` interface in `ps_io_ops_t`. It is preferred that the DMA | ||
| requests go through the `ps_dma_man_t` interfaces instead of using these | ||
| functions. |
There was a problem hiding this comment.
Not really a documentation question. Please add an issue if they should be moved.
| The allocator in libsel4camkes can be used to allocate seL4 capability objects | ||
| from a managed pool. The `camkes_provide` function is mostly used in the by the | ||
| CAmkES backend to setup the pool on behalf of the user. In `simple` or | ||
| 'dynamic' configurations of CAmkES, other allocators (`vka`, `vspace`, etc) |
There was a problem hiding this comment.
explain what simple and dynamic configurations are.
vka is an interface.
There was a problem hiding this comment.
Can we put this into an issue? Not having an answer to this question, but having the rest documented is a lot better than having no documentation at all.
|
@abrandnewusername Are you working on this or did this just get assigned to by accident? (It's fine if not, then somebody can take it over) |
Yes, I'm working on this, but I'm currently distracted by other works. I'm happy if anyone wants to contribute to this documentation. |
|
>>>> "Gerwin" == Gerwin Klein ***@***.***> writes:
> +When sending data over to the device side, it is preferred to use
> to these two functions.
Gerwin> I don't think we have a decided value for
Gerwin> markdown/documentation wrap. We have 120 for C and 100 for
Gerwin> Python, so 72 sounds a bit small, but smaller than code wrap
Gerwin> is justified for long text, I think.
I would prefer 72-75 for all of them.
Peter C
|
You made my fingers twitch :-) I don't see any reason to change the C or python standards (they do have good reasons), but we can have a discussion about longer text where we don't have any specific rules yet. Should not be on this PR, though. I might start something on discourse later. |
|
Is anything happening with this PR? I'd like it to be completed and merged ... |
lsf37
force-pushed
the
df-docs
branch
8 times, most recently
from
d715011
to
6eb7f82
Compare
|
I have rebased the PR and addressed the review feedback as far as I could (so far in a separate commit, to be squashed before merging). There are still a small number of open questions/requests. I would relegate these to an issue that people can keep working on. While maybe not complete, merging this PR in the current state is much better than what is there so far, and it doesn't look like anyone has had time to fully complete it in the past 3 years. |
This commit adds documentation written in markdown that explains each part of the libsel4camkes library in more depth. Signed-off-by: Gerwin Klein <[email protected]>
This commit adds documentation written in markdown that explains each part of the libsel4camkes library in more depth.
This appears to be draft documentation started by @kent-mcleod as part of developing the seL4 Device Driver Framework. It looks to be incomplete.
This might assume the API changes from #84