Received-SPF: pass (google.com: domain of linux-kernel+bounces-29907-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249;
From: Valentin Obst <kernel@valentinobst.de>
To: Miguel Ojeda <ojeda@kernel.org>,
	Alex Gaynor <alex.gaynor@gmail.com>,
	Wedson Almeida Filho <wedsonaf@gmail.com>,
	Trevor Gross <tmgross@umich.edu>
Cc: Boqun Feng <boqun.feng@gmail.com>,
	Gary Guo <gary@garyguo.net>,
	=?UTF-8?q?Bj=C3=B6rn=20Roy=20Baron?= <bjorn3_gh@protonmail.com>,
	Benno Lossin <benno.lossin@proton.me>,
	Andreas Hindborg <a.hindborg@samsung.com>,
	Alice Ryhl <aliceryhl@google.com>,
	rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Valentin Obst <kernel@valentinobst.de>
Subject: Re: [PATCH 10/13] rust: kernel: add doclinks
Date: Thu, 18 Jan 2024 09:41:09 +0100
Message-ID: <20240118084109.21400-1-kernel@valentinobst.de>
In-Reply-To: <CALNs47tWivxJhqjC-L8rLQKP420y1zCgCiHSZc5JPNbCVpwxgw@mail.gmail.com>
References: <CALNs47tWivxJhqjC-L8rLQKP420y1zCgCiHSZc5JPNbCVpwxgw@mail.gmail.com>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
UI-OutboundReport: notjunk:1;M01:P0:zI/P7vMDheI=;V8EodjK8E1xpKZ4NeALmkkDV3Cj
 HMbEqmAg5rWmV0xplS1ZzLbH9Bh5sL4MfA7QgoU/4zdzMUWBuy0xzVCyy2BihWyALvN7fQ87r
 KTuLYLDkEMl+O8HvawbougSD/UeDVgW4HVC3lk4bjXuFFzUd6NPQwEgUuSJD0cYvmnjpMpfQg
 URNtaHxbL/4ZejI6HkX4WbgHtgxrkey66VFGNvH2j+pH+vRbkwT3HDs0jFhziHRRApUI78PXe
 Sx0SFMbrXp8iqeQzBWz6gMW/TkHREvgYkdFS4KaLA60O1D44gHOnzJuqrRFAkHPvX73uQ/r27
 hXOHl4+6Asnvm03eXt3zUBsu2b+y3HPse790BqruhkzkblystWlicpr4Px6pHSQgm8c6wd9ti
 fnh6MxKA/Mb/NFSqIE4ord5RuqM/ONTNUfKSFSD58wPzWqkGm65LPAzC/LcbQQeCtOATvNfiQ
 my08RBahN7+cOwQq6lgTzHDCa7TWp18+rW7XBqP4fMj0pY0fs0RTf5Wn9P7KvaO7V8I+iTZ3x
 aQixfAinckUalF9Kdr6cyT+p/Ef/jAaJWTpB8MmCSJx9nxMOaW/Kt7oB3ZnDlHwzHtB/5mk8S
 F0FVSLlZ1/Wo/IzSV5a39C+nMW7uskj8tCmGOjNCLH1pJVP39yK4mgWtfqj8WvSUDbXqEXyk8
 Xur1FcR9rDptvKsrGUgsor3ehxNOcMmI5OIZOdXx7dyKCUfhzeNd1sBynVn52cxfwQdq5kb/Q
 FBBaj3YNW8pr8kvJTOVvrR7BlisBsuZst3IyssHaAqh0aoZZrtnGK7r+Cucx/V4lifLidomS1
 S2Ld/eVzQogQCzUla8Vm9OCDSxTtrFItAmaD53WSf50a2xyl/f9tegENmyVnaIy/gRDkC0gxj
 UgqrrvMszeg3AtA==

> >  /// # Invariants
> > diff --git a/rust/kernel/sync/lock.rs b/rust/kernel/sync/lock.rs
> > index 467249b39f71..f14179d19d4e 100644
> > --- a/rust/kernel/sync/lock.rs
> > +++ b/rust/kernel/sync/lock.rs
> > @@ -21,14 +21,21 @@
> >  /// # Safety
> >  ///
> >  /// - Implementers must ensure that only one thread/CPU may access the protected data once the lock
> > -/// is owned, that is, between calls to `lock` and `unlock`.
> > -/// - Implementers must also ensure that `relock` uses the same locking method as the original
> > +/// is owned, that is, between calls to [`lock`] and [`unlock`].
> > +/// - Implementers must also ensure that [`relock`] uses the same locking method as the original
> >  /// lock operation.

> The second lines of these list items should probably be indented
> (doesn't have to be in this patch).

Indeed. Will include it in the first commit in v2.

> > [...]
> > @@ -290,10 +294,11 @@ unsafe fn __enqueue<F>(self, queue_work_on: F) -> Self::EnqueueOutput
> >
> >  /// Defines the method that should be called directly when a work item is executed.
> >  ///
> > -/// This trait is implemented by `Pin<Box<T>>` and `Arc<T>`, and is mainly intended to be
> > +/// This trait is implemented by `Pin<Box<T>>` and [`Arc<T>`], and is mainly intended to be

> `Pin` could be linked too.

This requires the 'code' tags in the next commit and is done by linking
both `Pin` and `Box<T>`:

```rust
/// This trait is implemented by <code>[Pin]<[`Box<T>`]></code> and [`Arc<T>`], and is mainly
```