[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <CANiq72kR3YZv65NYPx+H57XO7T85kioMWMZajRnk7f+ru-3x+w@mail.gmail.com>
Date: Thu, 10 Nov 2022 20:14:17 +0100
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Boqun Feng <boqun.feng@...il.com>
Cc: Miguel Ojeda <ojeda@...nel.org>,
Wedson Almeida Filho <wedsonaf@...il.com>,
Alex Gaynor <alex.gaynor@...il.com>,
Gary Guo <gary@...yguo.net>,
Björn Roy Baron <bjorn3_gh@...tonmail.com>,
rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
patches@...ts.linux.dev, Niklas Mohrin <dev@...lasmohrin.de>
Subject: Re: [PATCH v1 23/28] rust: std_vendor: add `dbg!` macro based on
`std`'s one
On Thu, Nov 10, 2022 at 7:02 PM Boqun Feng <boqun.feng@...il.com> wrote:
>
> and I'm almost convinced ;-) Better add the gist of discussion into
> comment/document/commit log? Users need to know when to use `dbg!` and
> when to use `pr_debug!`, right?
The docs talk about it a bit:
+/// Note that the macro is intended as a debugging tool and therefore you
+/// should avoid having uses of it in version control for long periods
+/// (other than in tests and similar).
That is the original wording from the standard library, but we can
definitely make the rules more concrete on our end with something
like:
`dbg!` is intended as a temporary debugging tool to be used during
development. Therefore, avoid committing `dbg!` macro invocations
into the kernel tree.
For debug output that is intended to be kept, use `pr_debug!` and
similar facilities instead.
Cheers,
Miguel
Powered by blists - more mailing lists