2024-01-16 16:03:03

by Valentin Obst

Subject: [PATCH 03/13] rust: ioctl: end top level module docs with full stop

Every other module ends its first line of documentation with a full
stop. Adapt the only outlier.

Signed-off-by: Valentin Obst <[email protected]>
---
rust/kernel/ioctl.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs
index 59050e5f5a5a..5987ad6d38a7 100644
--- a/rust/kernel/ioctl.rs
+++ b/rust/kernel/ioctl.rs
@@ -1,6 +1,6 @@
// SPDX-License-Identifier: GPL-2.0

-//! ioctl() number definitions
+//! ioctl() number definitions.
//!
//! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)

--
2.43.0

2024-01-18 00:33:09

by Trevor Gross

Subject: Re: [PATCH 03/13] rust: ioctl: end top level module docs with full stop

On Tue, Jan 16, 2024 at 11:05 AM Valentin Obst <kernel@valentinobstde> wrote:
>
> Every other module ends its first line of documentation with a full
> stop. Adapt the only outlier.
>
> Signed-off-by: Valentin Obst <[email protected]>
> ---
> rust/kernel/ioctl.rs | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs
> index 59050e5f5a5a..5987ad6d38a7 100644
> --- a/rust/kernel/ioctl.rs
> +++ b/rust/kernel/ioctl.rs
> @@ -1,6 +1,6 @@
> // SPDX-License-Identifier: GPL-2.0
>
> -//! ioctl() number definitions
> +//! ioctl() number definitions.

Would you mind also adding backticks to `ioctl()` while you're here?

- Trevor

> //!
> //! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)
>
> --
> 2.43.0
>

2024-01-18 01:08:24

by Trevor Gross

Subject: Re: [PATCH 03/13] rust: ioctl: end top level module docs with full stop

On Wed, Jan 17, 2024 at 7:32 PM Trevor Gross <[email protected]> wrote:
>
> On Tue, Jan 16, 2024 at 11:05 AM Valentin Obst <[email protected]> wrote:
> >
> > Every other module ends its first line of documentation with a full
> > stop. Adapt the only outlier.
> >
> > Signed-off-by: Valentin Obst <[email protected]>
> > ---
> > rust/kernel/ioctl.rs | 2 +-
> > 1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs
> > index 59050e5f5a5a..5987ad6d38a7 100644
> > --- a/rust/kernel/ioctl.rs
> > +++ b/rust/kernel/ioctl.rs
> > @@ -1,6 +1,6 @@
> > // SPDX-License-Identifier: GPL-2.0
> >
> > -//! ioctl() number definitions
> > +//! ioctl() number definitions.
>
> Would you mind also adding backticks to `ioctl()` while you're here?
>
> - Trevor
>
> > //!
> > //! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)
> >
> > --
> > 2.43.0
> >

Nevermind, I see you got this in patch 8/13.

Reviewed-by: Trevor Gross <[email protected]>