mirrors/crosvm
1
0
Fork 0
mirror of https://chromium.googlesource.com/crosvm/crosvm synced 2025-02-11 04:26:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

devices: pci: fix markdown quoting in doc comments

Browse source 
Escape the square brackets in doc comments to resolve the rustdoc
warning.

BUG=None
TEST=tools/cargo-doc

Change-Id: I78f60ef65f57b213da2f0e687ee295b7e046db9e
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3630421
Tested-by: kokoro <noreply+kokoro@google.com>
Commit-Queue: Daniel Verkamp <dverkamp@chromium.org>
Reviewed-by: Dennis Kempin <denniskempin@google.com>
This commit is contained in:
Daniel Verkamp 2022-05-04 18:16:06 -07:00 committed by Chromeos LUCI
parent 5e43f03d80
commit 132957468f
2 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
devices/src/pci/msix.rs
View file

@ -333,7 +333,7 @@ impl MsixConfig {
/// for the memory write transaction; different MSI-X vectors have /// for the memory write transaction; different MSI-X vectors have
/// different Message Address values /// different Message Address values
/// Message Data: the contents of this field specifies the data driven /// Message Data: the contents of this field specifies the data driven
/// on AD[31::00] during the memory write transaction's data phase. /// on AD\[31::00\] during the memory write transaction's data phase.
/// Vector Control: only bit 0 (Mask Bit) is not reserved: when this bit /// Vector Control: only bit 0 (Mask Bit) is not reserved: when this bit
/// is set, the function is prohibited from sending a message using /// is set, the function is prohibited from sending a message using
/// this MSI-X Table entry. /// this MSI-X Table entry.
@ -428,7 +428,7 @@ impl MsixConfig {
/// * 'offset' - the offset within the PBA entries /// * 'offset' - the offset within the PBA entries
/// * 'data' - used to store the read results /// * 'data' - used to store the read results
/// ///
/// Pending Bits[63::00]: For each Pending Bit that is set, the function /// Pending Bits\[63::00\]: For each Pending Bit that is set, the function
/// has a pending message for the associated MSI-X Table entry. /// has a pending message for the associated MSI-X Table entry.
pub fn read_pba_entries(&self, offset: u64, data: &mut [u8]) { pub fn read_pba_entries(&self, offset: u64, data: &mut [u8]) {
let index: usize = (offset / MSIX_PBA_ENTRIES_MODULO) as usize; let index: usize = (offset / MSIX_PBA_ENTRIES_MODULO) as usize;

2
devices/src/pci/pci_address.rs
View file

@ -51,7 +51,7 @@ impl Display for PciAddress {
} }
} }
/// Construct PciAddress from string [domain:]bus:device.function. /// Construct PciAddress from string "\[domain:\]bus:device.function".
impl FromStr for PciAddress { impl FromStr for PciAddress {
type Err = Error; type Err = Error;