summary refs log tree commit diff stats
path: root/rust/qemu-api/README.md
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2024-11-13 09:11:48 +0100
committerPaolo Bonzini <pbonzini@redhat.com>2024-12-10 18:44:06 +0100
commitcab1d0bceb6d042674f6892216d1769021f73916 (patch)
tree872f6544c4dfa2e435584cc469435f859e5970b6 /rust/qemu-api/README.md
parent2f9eec8f72673f97766eba1682a75f06f16302cb (diff)
downloadfocaccia-qemu-cab1d0bceb6d042674f6892216d1769021f73916.tar.gz
focaccia-qemu-cab1d0bceb6d042674f6892216d1769021f73916.zip
rust: build: add "make clippy", "make rustfmt", "make rustdoc"
Abstract common invocations of "cargo", that do not require copying
the generated bindgen file or setting up MESON_BUILD_ROOT.

In the future these could also do completely without cargo and invoke
the underlying programs directly.

Reviewed-by: Junjie Mao <junjie.mao@hotmail.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'rust/qemu-api/README.md')
-rw-r--r--rust/qemu-api/README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/rust/qemu-api/README.md b/rust/qemu-api/README.md
index 53810f4888..ed1b7ab263 100644
--- a/rust/qemu-api/README.md
+++ b/rust/qemu-api/README.md
@@ -5,13 +5,15 @@ This library exports helper Rust types, Rust macros and C FFI bindings for inter
 The C bindings can be generated with `bindgen`, using this build target:
 
 ```console
-$ ninja bindings.inc.rs
+$ make bindings.inc.rs
 ```
 
 ## Generate Rust documentation
 
-To generate docs for this crate, including private items:
+Common Cargo tasks can be performed from the QEMU build directory
 
-```sh
-pyvenv/bin/meson devenv -w ../rust cargo doc --no-deps --document-private-items
+```console
+$ make clippy
+$ make rustfmt
+$ make rustdoc
 ```