Skip to content

Commit c23f4db

Browse files
roypatShadowCurse
authored andcommitted
doc(vcpu): Clean up doc comments
- Remove unneeded cfg(target_arch = ...) from doc tests of functions that are already cfg'd themselves to only exist on that arch - Remove unneeded code block in cpuid doc test. Signed-off-by: Patrick Roy <[email protected]>
1 parent 5ff0a25 commit c23f4db

File tree

1 file changed

+30
-40
lines changed

1 file changed

+30
-40
lines changed

src/ioctls/vcpu.rs

Lines changed: 30 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,6 @@ impl VcpuFd {
426426
/// let kvm = Kvm::new().unwrap();
427427
/// let vm = kvm.create_vm().unwrap();
428428
/// let vcpu = vm.create_vcpu(0).unwrap();
429-
/// #[cfg(target_arch = "x86_64")]
430429
/// let fpu = vcpu.get_fpu().unwrap();
431430
/// ```
432431
#[cfg(target_arch = "x86_64")]
@@ -457,15 +456,13 @@ impl VcpuFd {
457456
/// let kvm = Kvm::new().unwrap();
458457
/// let vm = kvm.create_vm().unwrap();
459458
/// let vcpu = vm.create_vcpu(0).unwrap();
460-
/// #[cfg(target_arch = "x86_64")]
461-
/// {
462-
/// let KVM_FPU_CWD: u16 = 0x37f;
463-
/// let fpu = kvm_fpu {
464-
/// fcw: KVM_FPU_CWD,
465-
/// ..Default::default()
466-
/// };
467-
/// vcpu.set_fpu(&fpu).unwrap();
468-
/// }
459+
///
460+
/// let KVM_FPU_CWD: u16 = 0x37f;
461+
/// let fpu = kvm_fpu {
462+
/// fcw: KVM_FPU_CWD,
463+
/// ..Default::default()
464+
/// };
465+
/// vcpu.set_fpu(&fpu).unwrap();
469466
/// ```
470467
#[cfg(target_arch = "x86_64")]
471468
pub fn set_fpu(&self, fpu: &kvm_fpu) -> Result<()> {
@@ -499,13 +496,11 @@ impl VcpuFd {
499496
///
500497
/// // Update the CPUID entries to disable the EPB feature.
501498
/// const ECX_EPB_SHIFT: u32 = 3;
502-
/// {
503-
/// let entries = kvm_cpuid.as_mut_slice();
504-
/// for entry in entries.iter_mut() {
505-
/// match entry.function {
506-
/// 6 => entry.ecx &= !(1 << ECX_EPB_SHIFT),
507-
/// _ => (),
508-
/// }
499+
/// let entries = kvm_cpuid.as_mut_slice();
500+
/// for entry in entries.iter_mut() {
501+
/// match entry.function {
502+
/// 6 => entry.ecx &= !(1 << ECX_EPB_SHIFT),
503+
/// _ => (),
509504
/// }
510505
/// }
511506
///
@@ -581,18 +576,16 @@ impl VcpuFd {
581576
/// let kvm = Kvm::new().unwrap();
582577
/// let vm = kvm.create_vm().unwrap();
583578
/// let mut cap: kvm_enable_cap = Default::default();
584-
/// if cfg!(target_arch = "x86_64") {
585-
/// // KVM_CAP_HYPERV_SYNIC needs KVM_CAP_SPLIT_IRQCHIP enabled
586-
/// cap.cap = KVM_CAP_SPLIT_IRQCHIP;
587-
/// cap.args[0] = 24;
588-
/// vm.enable_cap(&cap).unwrap();
579+
/// // KVM_CAP_HYPERV_SYNIC needs KVM_CAP_SPLIT_IRQCHIP enabled
580+
/// cap.cap = KVM_CAP_SPLIT_IRQCHIP;
581+
/// cap.args[0] = 24;
582+
/// vm.enable_cap(&cap).unwrap();
589583
///
590-
/// let vcpu = vm.create_vcpu(0).unwrap();
591-
/// if kvm.check_extension(Cap::HypervSynic) {
592-
/// let mut cap: kvm_enable_cap = Default::default();
593-
/// cap.cap = KVM_CAP_HYPERV_SYNIC;
594-
/// vcpu.enable_cap(&cap).unwrap();
595-
/// }
584+
/// let vcpu = vm.create_vcpu(0).unwrap();
585+
/// if kvm.check_extension(Cap::HypervSynic) {
586+
/// let mut cap: kvm_enable_cap = Default::default();
587+
/// cap.cap = KVM_CAP_HYPERV_SYNIC;
588+
/// vcpu.enable_cap(&cap).unwrap();
596589
/// }
597590
/// ```
598591
///
@@ -1246,19 +1239,16 @@ impl VcpuFd {
12461239
/// let vm = kvm.create_vm().unwrap();
12471240
/// let vcpu = vm.create_vcpu(0).unwrap();
12481241
///
1249-
/// #[cfg(any(target_arch = "x86_64", target_arch = "aarch64"))]
1250-
/// {
1251-
/// let debug_struct = kvm_guest_debug {
1252-
/// // Configure the vcpu so that a KVM_DEBUG_EXIT would be generated
1253-
/// // when encountering a software breakpoint during execution
1254-
/// control: KVM_GUESTDBG_ENABLE | KVM_GUESTDBG_USE_SW_BP,
1255-
/// pad: 0,
1256-
/// // Reset all arch-specific debug registers
1257-
/// arch: Default::default(),
1258-
/// };
1242+
/// let debug_struct = kvm_guest_debug {
1243+
/// // Configure the vcpu so that a KVM_DEBUG_EXIT would be generated
1244+
/// // when encountering a software breakpoint during execution
1245+
/// control: KVM_GUESTDBG_ENABLE | KVM_GUESTDBG_USE_SW_BP,
1246+
/// pad: 0,
1247+
/// // Reset all arch-specific debug registers
1248+
/// arch: Default::default(),
1249+
/// };
12591250
///
1260-
/// vcpu.set_guest_debug(&debug_struct).unwrap();
1261-
/// }
1251+
/// vcpu.set_guest_debug(&debug_struct).unwrap();
12621252
/// ```
12631253
#[cfg(any(
12641254
target_arch = "x86_64",

0 commit comments

Comments
 (0)