Commit da514157 authored by Thorsten Leemhuis's avatar Thorsten Leemhuis Committed by Jonathan Corbet
Browse files

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: default avatarThorsten Leemhuis <linux@leemhuis.info>
Link: https://lore.kernel.org/r/3df7c2d16de112b47bb6e6158138608e78562bf5.1607063223.git.linux@leemhuis.info


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 3e544d72

Documentation/admin-guide/README.rst

+2 −2
Original line number Diff line number Diff line
@@ -398,8 +398,8 @@ If something goes wrong 


   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

   possible will help.  Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>`

   document for details.

   possible will help.  Please read

   'Documentation/admin-guide/reporting-issues.rst' for details.



 - 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

Documentation/admin-guide/bug-bisect.rst

+1 −1
Original line number Diff line number Diff line
@@ -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.



Before you submit a bug report read

:ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`.

'Documentation/admin-guide/reporting-issues.rst'.



Devices not appearing

=====================

Documentation/admin-guide/index.rst

+1 −1
Original line number Diff line number Diff line
@@ -35,7 +35,7 @@ problems and bugs in particular. 
   :maxdepth: 1



   reporting-issues

   reporting-bugs

   Reporting bugs (obsolete) <reporting-bugs>

   security-bugs

   bug-hunting

   bug-bisect

Documentation/admin-guide/reporting-bugs.rst

+5 −0
Original line number Diff line number Diff line 
.. _reportingbugs:



.. note::



   This document is obsolete, and will be replaced by

   'Documentation/admin-guide/reporting-issues.rst' in the near future.



Reporting bugs

++++++++++++++

Documentation/admin-guide/security-bugs.rst

+1 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ understand and fix the security vulnerability. 


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

: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

be released without consent from the reporter unless it has already been

made public.

CRA Git | Maintained and supported by SUSTech CRA and CCSE