docs: make reporting-bugs.rst obsolete
Make various places which point to Documentation/admin-guide/reporting-bugs.rst point to Documentation/admin-guide/reporting-issues.rst instead. That document is brand new and as of now is not completely finished. But even at this stage it's a lot more helpful and accurate than reporting-bugs.rst. Hence also add a note to reporting-bugs.rst, telling people they're better off reading reporting-issues.rst instead. reporting-bugs.rst is scheduled for removal once reporting-issues.rst is considered ready. Signed-off-by: Thorsten Leemhuis <linux@leemhuis.info> Link: https://lore.kernel.org/r/3df7c2d16de112b47bb6e6158138608e78562bf5.1607063223.git.linux@leemhuis.info Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
3e544d72df
commit
da514157c4
@ -398,8 +398,8 @@ If something goes wrong
|
|||||||
|
|
||||||
If you for some reason cannot do the above (you have a pre-compiled
|
If you for some reason cannot do the above (you have a pre-compiled
|
||||||
kernel image or similar), telling me as much about your setup as
|
kernel image or similar), telling me as much about your setup as
|
||||||
possible will help. Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
|
possible will help. Please read
|
||||||
document for details.
|
'Documentation/admin-guide/reporting-issues.rst' for details.
|
||||||
|
|
||||||
- Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
|
- Alternatively, you can use gdb on a running kernel. (read-only; i.e. you
|
||||||
cannot change values or set break points.) To do this, first compile the
|
cannot change values or set break points.) To do this, first compile the
|
||||||
|
@ -15,7 +15,7 @@ give up. Report as much as you have found to the relevant maintainer. See
|
|||||||
MAINTAINERS for who that is for the subsystem you have worked on.
|
MAINTAINERS for who that is for the subsystem you have worked on.
|
||||||
|
|
||||||
Before you submit a bug report read
|
Before you submit a bug report read
|
||||||
:ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`.
|
'Documentation/admin-guide/reporting-issues.rst'.
|
||||||
|
|
||||||
Devices not appearing
|
Devices not appearing
|
||||||
=====================
|
=====================
|
||||||
|
@ -35,7 +35,7 @@ problems and bugs in particular.
|
|||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
reporting-issues
|
reporting-issues
|
||||||
reporting-bugs
|
Reporting bugs (obsolete) <reporting-bugs>
|
||||||
security-bugs
|
security-bugs
|
||||||
bug-hunting
|
bug-hunting
|
||||||
bug-bisect
|
bug-bisect
|
||||||
|
@ -1,5 +1,10 @@
|
|||||||
.. _reportingbugs:
|
.. _reportingbugs:
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This document is obsolete, and will be replaced by
|
||||||
|
'Documentation/admin-guide/reporting-issues.rst' in the near future.
|
||||||
|
|
||||||
Reporting bugs
|
Reporting bugs
|
||||||
++++++++++++++
|
++++++++++++++
|
||||||
|
|
||||||
|
@ -21,7 +21,7 @@ understand and fix the security vulnerability.
|
|||||||
|
|
||||||
As it is with any bug, the more information provided the easier it
|
As it is with any bug, the more information provided the easier it
|
||||||
will be to diagnose and fix. Please review the procedure outlined in
|
will be to diagnose and fix. Please review the procedure outlined in
|
||||||
:doc:`reporting-bugs` if you are unclear about what
|
'Documentation/admin-guide/reporting-issues.rst' if you are unclear about what
|
||||||
information is helpful. Any exploit code is very helpful and will not
|
information is helpful. Any exploit code is very helpful and will not
|
||||||
be released without consent from the reporter unless it has already been
|
be released without consent from the reporter unless it has already been
|
||||||
made public.
|
made public.
|
||||||
|
@ -374,8 +374,8 @@ steps you should take:
|
|||||||
email address will be in the driver source or in the MAINTAINERS file.
|
email address will be in the driver source or in the MAINTAINERS file.
|
||||||
|
|
||||||
- The contents of your report will vary a lot depending upon the
|
- The contents of your report will vary a lot depending upon the
|
||||||
problem. If it's a kernel crash then you should refer to the
|
problem. If it's a kernel crash then you should refer to
|
||||||
admin-guide/reporting-bugs.rst file.
|
'Documentation/admin-guide/reporting-issues.rst'.
|
||||||
|
|
||||||
But for most problems it is useful to provide the following:
|
But for most problems it is useful to provide the following:
|
||||||
|
|
||||||
|
@ -348,11 +348,10 @@ tool. For details on how to use the kernel bugzilla, please see:
|
|||||||
|
|
||||||
https://bugzilla.kernel.org/page.cgi?id=faq.html
|
https://bugzilla.kernel.org/page.cgi?id=faq.html
|
||||||
|
|
||||||
The file :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`
|
The file 'Documentation/admin-guide/reporting-issues.rst' in the main kernel
|
||||||
in the main kernel source directory has a good
|
source directory has a good template for how to report a possible kernel bug,
|
||||||
template for how to report a possible kernel bug, and details what kind
|
and details what kind of information is needed by the kernel developers to help
|
||||||
of information is needed by the kernel developers to help track down the
|
track down the problem.
|
||||||
problem.
|
|
||||||
|
|
||||||
|
|
||||||
Managing bug reports
|
Managing bug reports
|
||||||
|
Loading…
Reference in New Issue
Block a user