[PATCH v2] rust: std_vendor: update dbg macro from rust upstream

Deepak Thukral posted 1 patch 1 month, 3 weeks ago
rust/kernel/std_vendor.rs | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
[PATCH v2] rust: std_vendor: update dbg macro from rust upstream
Posted by Deepak Thukral 1 month, 3 weeks ago
`dbg!` contain adapted code from rust upstream.
Compare code with rust upstream and update missing column
numbers in `dbg!` outputs. Column numbers are not copied
but adjusted for examples in docstring.

Thus update the docstring only.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://github.com/Rust-for-Linux/linux/issues/1124
Signed-off-by: Deepak Thukral <iapain@gmail.com>
---
Changelog:
v1->v2
- Adjusted line numbers which were affected by changes to macro.
- Recompare `dbg!` macro with rust upstream. No other changes required.
- Better commit message.
- Link to v1: https://lore.kernel.org/rust-for-linux/20241003221536.34826-1-iapain@gmail.com/
---
 rust/kernel/std_vendor.rs | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/rust/kernel/std_vendor.rs b/rust/kernel/std_vendor.rs
index 8f27d447a..279bd3536 100644
--- a/rust/kernel/std_vendor.rs
+++ b/rust/kernel/std_vendor.rs
@@ -18,7 +18,7 @@
 /// let a = 2;
 /// # #[expect(clippy::disallowed_macros)]
 /// let b = dbg!(a * 2) + 1;
-/// //      ^-- prints: [src/main.rs:2] a * 2 = 4
+/// //      ^-- prints: [src/main.rs:3:9] a * 2 = 4
 /// assert_eq!(b, 5);
 /// ```
 ///
@@ -67,7 +67,7 @@
 /// This prints to the kernel log:
 ///
 /// ```text,ignore
-/// [src/main.rs:4] n.checked_sub(4) = None
+/// [src/main.rs:3:8] n.checked_sub(4) = None
 /// ```
 ///
 /// Naive factorial implementation:
@@ -88,15 +88,15 @@
 /// This prints to the kernel log:
 ///
 /// ```text,ignore
-/// [src/main.rs:3] n <= 1 = false
-/// [src/main.rs:3] n <= 1 = false
-/// [src/main.rs:3] n <= 1 = false
-/// [src/main.rs:3] n <= 1 = true
-/// [src/main.rs:4] 1 = 1
-/// [src/main.rs:5] n * factorial(n - 1) = 2
-/// [src/main.rs:5] n * factorial(n - 1) = 6
-/// [src/main.rs:5] n * factorial(n - 1) = 24
-/// [src/main.rs:11] factorial(4) = 24
+/// [src/main.rs:3:8] n <= 1 = false
+/// [src/main.rs:3:8] n <= 1 = false
+/// [src/main.rs:3:8] n <= 1 = false
+/// [src/main.rs:3:8] n <= 1 = true
+/// [src/main.rs:4:9] 1 = 1
+/// [src/main.rs:5:9] n * factorial(n - 1) = 2
+/// [src/main.rs:5:9] n * factorial(n - 1) = 6
+/// [src/main.rs:5:9] n * factorial(n - 1) = 24
+/// [src/main.rs:11:1] factorial(4) = 24
 /// ```
 ///
 /// The `dbg!(..)` macro moves the input:
-- 
2.39.3
Re: [PATCH v2] rust: std_vendor: update dbg macro from rust upstream
Posted by Miguel Ojeda 1 month, 3 weeks ago
On Fri, Oct 4, 2024 at 3:09 PM Deepak Thukral <iapain@gmail.com> wrote:
>
> `dbg!` contain adapted code from rust upstream.
> Compare code with rust upstream and update missing column
> numbers in `dbg!` outputs. Column numbers are not copied
> but adjusted for examples in docstring.
>
> Thus update the docstring only.
>
> Suggested-by: Miguel Ojeda <ojeda@kernel.org>
> Link: https://github.com/Rust-for-Linux/linux/issues/1124
> Signed-off-by: Deepak Thukral <iapain@gmail.com>

Applied to `rust-next` (tags still welcome) -- thanks!

    [ Fixed typo and slightly reworded. - Miguel ]

Cheers,
Miguel