Re: [PATCH 2/2] Documentation: admin-guide: direct people to bug trackers, if specified
From: Joe Perches
Date: Wed Aug 28 2024 - 10:13:57 EST
On Thu, 2024-08-15 at 14:34 +0300, Jani Nikula wrote:
> Update bug reporting info in bug-hunting.rst to direct people to
> driver/subsystem bug trackers, if explicitly specified with the
> MAINTAINERS "B:" entry. Use the new get_maintainer.pl --bug option to
> print the info.
>
> Cc: Joe Perches <joe@xxxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Signed-off-by: Jani Nikula <jani.nikula@xxxxxxxxx>
> ---
> Documentation/admin-guide/bug-hunting.rst | 17 +++++++++--------
> 1 file changed, 9 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/admin-guide/bug-hunting.rst b/Documentation/admin-guide/bug-hunting.rst
> index 95299b08c405..1d0f8ceb3075 100644
> --- a/Documentation/admin-guide/bug-hunting.rst
> +++ b/Documentation/admin-guide/bug-hunting.rst
> @@ -244,14 +244,14 @@ Reporting the bug
> Once you find where the bug happened, by inspecting its location,
> you could either try to fix it yourself or report it upstream.
>
> -In order to report it upstream, you should identify the mailing list
> -used for the development of the affected code. This can be done by using
> -the ``get_maintainer.pl`` script.
> +In order to report it upstream, you should identify the bug tracker, if any, or
> +mailing list used for the development of the affected code. This can be done by
> +using the ``get_maintainer.pl`` script.
>
> For example, if you find a bug at the gspca's sonixj.c file, you can get
> its maintainers with::
Please use examples with and without B: entries.
>
> - $ ./scripts/get_maintainer.pl -f drivers/media/usb/gspca/sonixj.c
> + $ ./scripts/get_maintainer.pl --bug -f drivers/media/usb/gspca/sonixj.c
> Hans Verkuil <hverkuil@xxxxxxxxx> (odd fixer:GSPCA USB WEBCAM DRIVER,commit_signer:1/1=100%)
> Mauro Carvalho Chehab <mchehab@xxxxxxxxxx> (maintainer:MEDIA INPUT INFRASTRUCTURE (V4L/DVB),commit_signer:1/1=100%)
> Tejun Heo <tj@xxxxxxxxxx> (commit_signer:1/1=100%)
> @@ -267,11 +267,12 @@ Please notice that it will point to:
> - The driver maintainer (Hans Verkuil);
> - The subsystem maintainer (Mauro Carvalho Chehab);
> - The driver and/or subsystem mailing list (linux-media@xxxxxxxxxxxxxxx);
> -- the Linux Kernel mailing list (linux-kernel@xxxxxxxxxxxxxxx).
> +- The Linux Kernel mailing list (linux-kernel@xxxxxxxxxxxxxxx);
> +- The bug reporting URIs for the driver/subsystem (none in the above example).
>
> -Usually, the fastest way to have your bug fixed is to report it to mailing
> -list used for the development of the code (linux-media ML) copying the
> -driver maintainer (Hans).
> +If the listing contains bug reporting URIs at the end, please prefer them over
> +email. Otherwise, please report bugs to the mailing list used for the
> +development of the code (linux-media ML) copying the driver maintainer (Hans).
I think that's quite poorly described as it could ignore
any other reporter/developer or person that introduced
the defect.