[PATCH v10 1/5] rust: retitle "Example" section as "Examples"
0 views
Skip to first unread message
Tamir Duberstein
May 24, 2025, 4:33:23 PM5/24/25
to Michal Rostecki, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron, Andreas Hindborg, Alice Ryhl, Trevor Gross, Brendan Higgins, David Gow, Rae Moar, Danilo Krummrich, Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter, Greg Kroah-Hartman, Rafael J. Wysocki, Luis Chamberlain, Russ Weight, FUJITA Tomonori, Rob Herring, Saravana Kannan, Peter Zijlstra, Ingo Molnar, Will Deacon, Waiman Long, Nathan Chancellor, Nick Desaulniers, Bill Wendling, Justin Stitt, Andrew Lunn, Heiner Kallweit, Russell King, David S. Miller, Eric Dumazet, Jakub Kicinski, Paolo Abeni, Bjorn Helgaas, Arnd Bergmann, Jens Axboe, Benno Lossin, Krzysztof Wilczyński, rust-fo...@vger.kernel.org, linux-...@vger.kernel.org, linux-k...@vger.kernel.org, kuni...@googlegroups.com, dri-...@lists.freedesktop.org, net...@vger.kernel.org, devic...@vger.kernel.org, ll...@lists.linux.dev, linu...@vger.kernel.org, nou...@lists.freedesktop.org, linux...@vger.kernel.org, Tamir Duberstein
This title is consistent with all other macros' documentation,
regardless of the number of examples contained in their "Examples"
sections.
Signed-off-by: Tamir Duberstein <tam...@gmail.com>
---
rust/macros/lib.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index 9acaa68c974e..d31e50c446b0 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -263,7 +263,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream {
/// literals (lifetimes and documentation strings are not supported). There is a difference in
/// supported modifiers as well.
///
-/// # Example
+/// # Examples
///
/// ```
/// # const binder_driver_return_protocol_BR_OK: u32 = 0;
--
2.49.0
regardless of the number of examples contained in their "Examples"
sections.
Signed-off-by: Tamir Duberstein <tam...@gmail.com>
---
rust/macros/lib.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs
index 9acaa68c974e..d31e50c446b0 100644
--- a/rust/macros/lib.rs
+++ b/rust/macros/lib.rs
@@ -263,7 +263,7 @@ pub fn concat_idents(ts: TokenStream) -> TokenStream {
/// literals (lifetimes and documentation strings are not supported). There is a difference in
/// supported modifiers as well.
///
-/// # Example
+/// # Examples
///
/// ```
/// # const binder_driver_return_protocol_BR_OK: u32 = 0;
--
2.49.0
Benno Lossin
May 26, 2025, 7:29:03 AM5/26/25
to Tamir Duberstein, Michal Rostecki, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron, Andreas Hindborg, Alice Ryhl, Trevor Gross, Brendan Higgins, David Gow, Rae Moar, Danilo Krummrich, Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter, Greg Kroah-Hartman, Rafael J. Wysocki, Luis Chamberlain, Russ Weight, FUJITA Tomonori, Rob Herring, Saravana Kannan, Peter Zijlstra, Ingo Molnar, Will Deacon, Waiman Long, Nathan Chancellor, Nick Desaulniers, Bill Wendling, Justin Stitt, Andrew Lunn, Heiner Kallweit, Russell King, David S. Miller, Eric Dumazet, Jakub Kicinski, Paolo Abeni, Bjorn Helgaas, Arnd Bergmann, Jens Axboe, Krzysztof Wilczyński, rust-fo...@vger.kernel.org, linux-...@vger.kernel.org, linux-k...@vger.kernel.org, kuni...@googlegroups.com, dri-...@lists.freedesktop.org, net...@vger.kernel.org, devic...@vger.kernel.org, ll...@lists.linux.dev, linu...@vger.kernel.org, nou...@lists.freedesktop.org, linux...@vger.kernel.org
On Sat May 24, 2025 at 10:33 PM CEST, Tamir Duberstein wrote:
> This title is consistent with all other macros' documentation,
> regardless of the number of examples contained in their "Examples"
> sections.
>
> Signed-off-by: Tamir Duberstein <tam...@gmail.com>
Reviewed-by: Benno Lossin <los...@kernel.org>
> This title is consistent with all other macros' documentation,
> regardless of the number of examples contained in their "Examples"
> sections.
>
> Signed-off-by: Tamir Duberstein <tam...@gmail.com>
---
Cheers,
Benno
Miguel Ojeda
May 26, 2025, 12:15:27 PM5/26/25
to Tamir Duberstein, Patrick Miller, Hridesh MG, Michal Rostecki, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron, Andreas Hindborg, Alice Ryhl, Trevor Gross, Brendan Higgins, David Gow, Rae Moar, Danilo Krummrich, Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter, Greg Kroah-Hartman, Rafael J. Wysocki, Luis Chamberlain, Russ Weight, FUJITA Tomonori, Rob Herring, Saravana Kannan, Peter Zijlstra, Ingo Molnar, Will Deacon, Waiman Long, Nathan Chancellor, Nick Desaulniers, Bill Wendling, Justin Stitt, Andrew Lunn, Heiner Kallweit, Russell King, David S. Miller, Eric Dumazet, Jakub Kicinski, Paolo Abeni, Bjorn Helgaas, Arnd Bergmann, Jens Axboe, Benno Lossin, Krzysztof Wilczyński, rust-fo...@vger.kernel.org, linux-...@vger.kernel.org, linux-k...@vger.kernel.org, kuni...@googlegroups.com, dri-...@lists.freedesktop.org, net...@vger.kernel.org, devic...@vger.kernel.org, ll...@lists.linux.dev, linu...@vger.kernel.org, nou...@lists.freedesktop.org, linux...@vger.kernel.org
On Sat, May 24, 2025 at 10:33 PM Tamir Duberstein <tam...@gmail.com> wrote:
>
> This title is consistent with all other macros' documentation,
> regardless of the number of examples contained in their "Examples"
> sections.
>
> Signed-off-by: Tamir Duberstein <tam...@gmail.com>
I was going to say that I could take this one independently, but we
>
> This title is consistent with all other macros' documentation,
> regardless of the number of examples contained in their "Examples"
> sections.
>
> Signed-off-by: Tamir Duberstein <tam...@gmail.com>
already had #1 of:
https://lore.kernel.org/rust-for-linux/20240906164448.22...@proton.me/
I will take that one (which given the `checkpatch.pl` one got stalled,
I should have taken it separately as I mentioned at some point).
Patrick/Hridesh: there are new cases arriving (i.e. singular section
names), so it would be great if the `checkpatch.pl` patch discussion
could be restarted to see if we can land it, i.e. there is now even
more justification behind it just after some months. Thanks!
Cheers,
Miguel
Tamir Duberstein
May 26, 2025, 4:42:27 PM5/26/25
to Miguel Ojeda, Patrick Miller, Hridesh MG, Michal Rostecki, Miguel Ojeda, Alex Gaynor, Boqun Feng, Gary Guo, Björn Roy Baron, Andreas Hindborg, Alice Ryhl, Trevor Gross, Brendan Higgins, David Gow, Rae Moar, Danilo Krummrich, Maarten Lankhorst, Maxime Ripard, Thomas Zimmermann, David Airlie, Simona Vetter, Greg Kroah-Hartman, Rafael J. Wysocki, Luis Chamberlain, Russ Weight, FUJITA Tomonori, Rob Herring, Saravana Kannan, Peter Zijlstra, Ingo Molnar, Will Deacon, Waiman Long, Nathan Chancellor, Nick Desaulniers, Bill Wendling, Justin Stitt, Andrew Lunn, Heiner Kallweit, Russell King, David S. Miller, Eric Dumazet, Jakub Kicinski, Paolo Abeni, Bjorn Helgaas, Arnd Bergmann, Jens Axboe, Benno Lossin, Krzysztof Wilczyński, rust-fo...@vger.kernel.org, linux-...@vger.kernel.org, linux-k...@vger.kernel.org, kuni...@googlegroups.com, dri-...@lists.freedesktop.org, net...@vger.kernel.org, devic...@vger.kernel.org, ll...@lists.linux.dev, linu...@vger.kernel.org, nou...@lists.freedesktop.org, linux...@vger.kernel.org
On Mon, May 26, 2025 at 12:15 PM Miguel Ojeda
<miguel.oje...@gmail.com> wrote:
>
> On Sat, May 24, 2025 at 10:33 PM Tamir Duberstein <tam...@gmail.com> wrote:
> >
> > This title is consistent with all other macros' documentation,
> > regardless of the number of examples contained in their "Examples"
> > sections.
> >
> > Signed-off-by: Tamir Duberstein <tam...@gmail.com>
>
> I was going to say that I could take this one independently, but we
> already had #1 of:
>
> https://lore.kernel.org/rust-for-linux/20240906164448.22...@proton.me/
>
> I will take that one (which given the `checkpatch.pl` one got stalled,
> I should have taken it separately as I mentioned at some point).
Sounds good. I'll drop this one.
<miguel.oje...@gmail.com> wrote:
>
> On Sat, May 24, 2025 at 10:33 PM Tamir Duberstein <tam...@gmail.com> wrote:
> >
> > This title is consistent with all other macros' documentation,
> > regardless of the number of examples contained in their "Examples"
> > sections.
> >
> > Signed-off-by: Tamir Duberstein <tam...@gmail.com>
>
> I was going to say that I could take this one independently, but we
> already had #1 of:
>
> https://lore.kernel.org/rust-for-linux/20240906164448.22...@proton.me/
>
> I will take that one (which given the `checkpatch.pl` one got stalled,
> I should have taken it separately as I mentioned at some point).
Reply all
Reply to author
Forward
0 new messages