From 5a5110d290c0f2dca3d98c608b0ec9a01d2181b9 Mon Sep 17 00:00:00 2001 From: Manos Pitsidianakis Date: Thu, 3 Oct 2024 16:28:49 +0300 Subject: 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 Co-authored-by: Paolo Bonzini Signed-off-by: Junjie Mao Signed-off-by: Paolo Bonzini Signed-off-by: Manos Pitsidianakis Link: https://lore.kernel.org/r/0fb23fbe211761b263aacec03deaf85c0cc39995.1727961605.git.manos.pitsidianakis@linaro.org Signed-off-by: Paolo Bonzini --- rust/qemu-api/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 rust/qemu-api/README.md (limited to 'rust/qemu-api/README.md') 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 +``` -- cgit 1.4.1