-
Notifications
You must be signed in to change notification settings - Fork 113
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
Consolidate Oak ABI documentation #877
Labels
Comments
Is this the same as #812 ? |
tiziano88
added a commit
to tiziano88/oak
that referenced
this issue
May 12, 2020
I was tired of trying to keep the parameter numbers in sync :) Ref project-oak#877
tiziano88
added a commit
to tiziano88/oak
that referenced
this issue
May 12, 2020
I was tired of trying to keep the parameter numbers in sync :) Fix ABI documentation to not repeat types, and use terminology more in line with standard WebAssembly (see https://hacks.mozilla.org/2019/11/multi-value-all-the-wasm/ for the choice of `param` and `result` in particular). Ref project-oak#877
tiziano88
added a commit
to tiziano88/oak
that referenced
this issue
May 12, 2020
I was tired of trying to keep the parameter numbers in sync :) Fix ABI documentation to not repeat types, and use terminology more in line with standard WebAssembly (see https://hacks.mozilla.org/2019/11/multi-value-all-the-wasm/ for the choice of `param` and `result` in particular). Ref project-oak#877
6 tasks
tiziano88
added a commit
that referenced
this issue
May 12, 2020
I was tired of trying to keep the parameter numbers in sync :) Fix ABI documentation to not repeat types, and use terminology more in line with standard WebAssembly (see https://hacks.mozilla.org/2019/11/multi-value-all-the-wasm/ for the choice of `param` and `result` in particular). Ref #877
Some of the duplicate comments have been removed (two copies dropped in #883, one in #979). Current places that describe ABI functions, using
De-duped enough? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Currently the documentation of ABI-level functions is partially replicated in various places. In some cases it makes sense for it to be more precise in the context of a particular object or programming language, but I wonder whether we can do a better job at least at cross-referencing these various pieces together.
For instance, for the
node_create
call:Runtime
object:oak/oak/server/rust/oak_runtime/src/runtime/mod.rs
Lines 787 to 798 in bc98624
oak_abi
crate:oak/oak/server/rust/oak_abi/src/lib.rs
Lines 131 to 142 in bc98624
Oak ABI documentation:
https://github.com/project-oak/oak/blob/bc98624bdcf6629c4f3ef4aa139bd4a0892f3744/docs/abi.md#node_create
@daviddrysdale do you have any ideas / suggestions?
The text was updated successfully, but these errors were encountered: