mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Jani Nikula <jani.nikula@intel.com>,
	linux-kernel@vger.kernel.org,  linux-doc@vger.kernel.org
Cc: Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH 2/2] Documentation: admin-guide: direct people to bug trackers, if specified
Date: Fri, 16 Aug 2024 20:54:05 -0700	[thread overview]
Message-ID: <bb845fb26a97737f212c861022651e8bac82cd29.camel@perches.com> (raw)
In-Reply-To: <20240815113450.3397499-2-jani.nikula@intel.com>

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@perches.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Signed-off-by: Jani Nikula <jani.nikula@intel.com>
> ---
>  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::
>  
> -	$ ./scripts/get_maintainer.pl -f drivers/media/usb/gspca/sonixj.c
> +	$ ./scripts/get_maintainer.pl --bug -f drivers/media/usb/gspca/sonixj.c

Might not be the best use as B: entries are URIs and not email addresses

Maybe change the text above it too.

>  	Hans Verkuil <hverkuil@xs4all.nl> (odd fixer:GSPCA USB WEBCAM DRIVER,commit_signer:1/1=100%)
>  	Mauro Carvalho Chehab <mchehab@kernel.org> (maintainer:MEDIA INPUT INFRASTRUCTURE (V4L/DVB),commit_signer:1/1=100%)
>  	Tejun Heo <tj@kernel.org> (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@vger.kernel.org);
> -- the Linux Kernel mailing list (linux-kernel@vger.kernel.org).
> +- The Linux Kernel mailing list (linux-kernel@vger.kernel.org);
> +- The bug reporting URIs for the driver/subsystem (none in the above example).

Maybe change the example to show a file/subsystem with a B: entry.


  reply	other threads:[~2024-08-17  4:10 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-08-15 11:34 [PATCH 1/2] get_maintainer: add --bug option to print bug reporting info Jani Nikula
2024-08-15 11:34 ` [PATCH 2/2] Documentation: admin-guide: direct people to bug trackers, if specified Jani Nikula
2024-08-17  3:54   ` Joe Perches [this message]
2024-08-28 14:04   ` Joe Perches
2024-08-17  3:54 ` [PATCH 1/2] get_maintainer: add --bug option to print bug reporting info Joe Perches
2024-08-26 22:10 ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bb845fb26a97737f212c861022651e8bac82cd29.camel@perches.com \
    --to=joe@perches.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®