Commit 0b864375 authored by Andreas Hindborg's avatar Andreas Hindborg Committed by Peter Zijlstra
Browse files

rust: sync: atomic: Update documentation for `fetch_add()` 



The documentation for `fetch_add()` does not indicate that the original
value is returned by `fetch_add()`. Update the documentation so this is
clear.

Signed-off-by: default avatarAndreas Hindborg <a.hindborg@kernel.org>
Signed-off-by: default avatarBoqun Feng <boqun@kernel.org>
Signed-off-by: default avatarPeter Zijlstra (Intel) <peterz@infradead.org>
Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
Link: https://patch.msgid.link/20260220-atomic-sub-v3-2-e63cbed1d2aa@kernel.org
Link: https://patch.msgid.link/20260303201701.12204-13-boqun@kernel.org
parent c49cf341

rust/kernel/sync/atomic.rs

+4 −6
Original line number Diff line number Diff line
@@ -545,16 +545,14 @@ pub fn add<Rhs>(&self, v: Rhs, _: ordering::Relaxed) 
    /// use kernel::sync::atomic::{Atomic, Acquire, Full, Relaxed};

    ///

    /// let x = Atomic::new(42);

    ///

    /// assert_eq!(42, x.load(Relaxed));

    ///

    /// assert_eq!(54, { x.fetch_add(12, Acquire); x.load(Relaxed) });

    /// assert_eq!(42, x.fetch_add(12, Acquire));

    /// assert_eq!(54, x.load(Relaxed));

    ///

    /// let x = Atomic::new(42);

    ///

    /// assert_eq!(42, x.load(Relaxed));

    ///

    /// assert_eq!(54, { x.fetch_add(12, Full); x.load(Relaxed) } );

    /// assert_eq!(42, x.fetch_add(12, Full));

    /// assert_eq!(54, x.load(Relaxed));

    /// ```

    #[inline(always)]

    pub fn fetch_add<Rhs, Ordering: ordering::Ordering>(&self, v: Rhs, _: Ordering) -> T