Skip to content

Commit

Permalink
rust: phy: use srctree-relative links
Browse files Browse the repository at this point in the history
The relative paths like the following are bothersome and don't work
with `O=` builds:

//! C headers: [`include/linux/phy.h`](../../../../../../../include/linux/phy.h).

This updates such links by using the `srctree`-relative link feature
introduced in 6.8-rc1 like:

//! C headers: [`include/linux/phy.h`](srctree/include/linux/phy.h).

Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
Reviewed-by: Trevor Gross <tmgross@umich.edu>
Signed-off-by: David S. Miller <davem@davemloft.net>
  • Loading branch information
FUJITA Tomonori authored and David S. Miller committed Jan 27, 2024
1 parent a70f258 commit 1d4046b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions rust/kernel/net/phy.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

//! Network PHY device.
//!
//! C headers: [`include/linux/phy.h`](../../../../../../../include/linux/phy.h).
//! C headers: [`include/linux/phy.h`](srctree/include/linux/phy.h).

use crate::{bindings, error::*, prelude::*, str::CStr, types::Opaque};

Expand All @@ -16,7 +16,7 @@ use core::marker::PhantomData;
///
/// Some of PHY drivers access to the state of PHY's software state machine.
///
/// [`enum phy_state`]: ../../../../../../../include/linux/phy.h
/// [`enum phy_state`]: srctree/include/linux/phy.h
#[derive(PartialEq, Eq)]
pub enum DeviceState {
/// PHY device and driver are not ready for anything.
Expand Down Expand Up @@ -61,7 +61,7 @@ pub enum DuplexMode {
/// Referencing a `phy_device` using this struct asserts that you are in
/// a context where all methods defined on this struct are safe to call.
///
/// [`struct phy_device`]: ../../../../../../../include/linux/phy.h
/// [`struct phy_device`]: srctree/include/linux/phy.h
// During the calls to most functions in [`Driver`], the C side (`PHYLIB`) holds a lock that is
// unique for every instance of [`Device`]. `PHYLIB` uses a different serialization technique for
// [`Driver::resume`] and [`Driver::suspend`]: `PHYLIB` updates `phy_device`'s state with
Expand Down Expand Up @@ -486,7 +486,7 @@ impl<T: Driver> Adapter<T> {
///
/// `self.0` is always in a valid state.
///
/// [`struct phy_driver`]: ../../../../../../../include/linux/phy.h
/// [`struct phy_driver`]: srctree/include/linux/phy.h
#[repr(transparent)]
pub struct DriverVTable(Opaque<bindings::phy_driver>);

Expand Down

0 comments on commit 1d4046b

Please sign in to comment.