diff options
| author | Manos Pitsidianakis <manos.pitsidianakis@linaro.org> | 2024-10-03 16:28:49 +0300 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2024-10-11 12:32:17 +0200 |
| commit | 5a5110d290c0f2dca3d98c608b0ec9a01d2181b9 (patch) | |
| tree | be22aaecedc4bd8dad05dff6ea3b308a31c8e4ac /rust/qemu-api/README.md | |
| parent | dc43b18d2e1ed50e6c912427d5f7fbd2c62007bb (diff) | |
| download | focaccia-qemu-5a5110d290c0f2dca3d98c608b0ec9a01d2181b9.tar.gz focaccia-qemu-5a5110d290c0f2dca3d98c608b0ec9a01d2181b9.zip | |
rust: add crate to expose bindings and interfaces
Add rust/qemu-api, which exposes rust-bindgen generated FFI bindings and provides some declaration macros for symbols visible to the rest of QEMU. Co-authored-by: Junjie Mao <junjie.mao@intel.com> Co-authored-by: Paolo Bonzini <pbonzini@redhat.com> Signed-off-by: Junjie Mao <junjie.mao@intel.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org> Link: https://lore.kernel.org/r/0fb23fbe211761b263aacec03deaf85c0cc39995.1727961605.git.manos.pitsidianakis@linaro.org Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'rust/qemu-api/README.md')
| -rw-r--r-- | rust/qemu-api/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/rust/qemu-api/README.md b/rust/qemu-api/README.md new file mode 100644 index 0000000000..7588fa29ef --- /dev/null +++ b/rust/qemu-api/README.md @@ -0,0 +1,17 @@ +# QEMU bindings and API wrappers + +This library exports helper Rust types, Rust macros and C FFI bindings for internal QEMU APIs. + +The C bindings can be generated with `bindgen`, using this build target: + +```console +$ ninja bindings.rs +``` + +## Generate Rust documentation + +To generate docs for this crate, including private items: + +```sh +cargo doc --no-deps --document-private-items +``` |