rust: hide panicking default associated constants from rustdoc

[PATCH] rust: hide panicking default associated constants from rustdoc

Paolo Bonzini posted 1 patch 1 week, 2 days ago

Download mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20251204105017.2564277-1-pbonzini@redhat.com

Maintainers: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>

rust/hw/core/src/qdev.rs      | 1 +
rust/migration/src/vmstate.rs | 1 +
2 files changed, 2 insertions(+)

Expand all Fold all

[PATCH] rust: hide panicking default associated constants from rustdoc

Posted by Paolo Bonzini 1 week, 2 days ago

Work around rustdoc issue that panics while trying to evaluate
the constants.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 rust/hw/core/src/qdev.rs      | 1 +
 rust/migration/src/vmstate.rs | 1 +
 2 files changed, 2 insertions(+)

diff --git a/rust/hw/core/src/qdev.rs b/rust/hw/core/src/qdev.rs
index 4e983da28b7..c2ca17f6ce0 100644
--- a/rust/hw/core/src/qdev.rs
+++ b/rust/hw/core/src/qdev.rs
@@ -132,6 +132,7 @@ pub trait ResettablePhasesImpl {
 /// [`bindings::PropertyInfo`] pointer for the trait implementation to be safe.
 pub unsafe trait QDevProp {
     const BASE_INFO: *const bindings::PropertyInfo;
+    #[doc(hidden)] // https://github.com/rust-lang/rust/issues/149635
     const BIT_INFO: *const bindings::PropertyInfo = {
         panic!("invalid type for bit property");
     };
diff --git a/rust/migration/src/vmstate.rs b/rust/migration/src/vmstate.rs
index 267f9c8e053..f9d9f335b98 100644
--- a/rust/migration/src/vmstate.rs
+++ b/rust/migration/src/vmstate.rs
@@ -101,6 +101,7 @@ pub unsafe trait VMState {
     /// type for the length (i.e. if it is not `u8`, `u16`, `u32`), using it
     /// in a call to [`vmstate_of!`](crate::vmstate_of) will cause a
     /// compile-time error.
+    #[doc(hidden)] // https://github.com/rust-lang/rust/issues/149635
     const VARRAY_FLAG: VMStateFlags = {
         panic!("invalid type for variable-sized array");
     };
-- 
2.52.0

Re: [PATCH] rust: hide panicking default associated constants from rustdoc

Posted by Zhao Liu 5 days, 22 hours ago

On Thu, Dec 04, 2025 at 11:50:17AM +0100, Paolo Bonzini wrote:
> Date: Thu,  4 Dec 2025 11:50:17 +0100
> From: Paolo Bonzini <pbonzini@redhat.com>
> Subject: [PATCH] rust: hide panicking default associated constants from
>  rustdoc
> X-Mailer: git-send-email 2.52.0
> 
> Work around rustdoc issue that panics while trying to evaluate
> the constants.
> 
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  rust/hw/core/src/qdev.rs      | 1 +
>  rust/migration/src/vmstate.rs | 1 +
>  2 files changed, 2 insertions(+)

Reviewed-by: Zhao Liu <zhao1.liu@intel.com>