Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Thorsten Leemhuis and committed by
Jonathan Corbet
da514157 3e544d72

+16 -12
+2 -2
Documentation/admin-guide/README.rst
··· 398 398 399 399 If you for some reason cannot do the above (you have a pre-compiled 400 400 kernel image or similar), telling me as much about your setup as 401 - possible will help. Please read the :ref:`admin-guide/reporting-bugs.rst <reportingbugs>` 402 - document for details. 401 + possible will help. Please read 402 + 'Documentation/admin-guide/reporting-issues.rst' for details. 403 403 404 404 - Alternatively, you can use gdb on a running kernel. (read-only; i.e. you 405 405 cannot change values or set break points.) To do this, first compile the
+1 -1
Documentation/admin-guide/bug-bisect.rst
··· 15 15 MAINTAINERS for who that is for the subsystem you have worked on. 16 16 17 17 Before you submit a bug report read 18 - :ref:`Documentation/admin-guide/reporting-bugs.rst <reportingbugs>`. 18 + 'Documentation/admin-guide/reporting-issues.rst'. 19 19 20 20 Devices not appearing 21 21 =====================
+1 -1
Documentation/admin-guide/index.rst
··· 35 35 :maxdepth: 1 36 36 37 37 reporting-issues 38 - reporting-bugs 38 + Reporting bugs (obsolete) <reporting-bugs> 39 39 security-bugs 40 40 bug-hunting 41 41 bug-bisect
+5
Documentation/admin-guide/reporting-bugs.rst
··· 1 1 .. _reportingbugs: 2 2 3 + .. note:: 4 + 5 + This document is obsolete, and will be replaced by 6 + 'Documentation/admin-guide/reporting-issues.rst' in the near future. 7 + 3 8 Reporting bugs 4 9 ++++++++++++++ 5 10
+1 -1
Documentation/admin-guide/security-bugs.rst
··· 21 21 22 22 As it is with any bug, the more information provided the easier it 23 23 will be to diagnose and fix. Please review the procedure outlined in 24 - :doc:`reporting-bugs` if you are unclear about what 24 + 'Documentation/admin-guide/reporting-issues.rst' if you are unclear about what 25 25 information is helpful. Any exploit code is very helpful and will not 26 26 be released without consent from the reporter unless it has already been 27 27 made public.
+2 -2
Documentation/networking/device_drivers/ethernet/3com/vortex.rst
··· 374 374 email address will be in the driver source or in the MAINTAINERS file. 375 375 376 376 - The contents of your report will vary a lot depending upon the 377 - problem. If it's a kernel crash then you should refer to the 378 - admin-guide/reporting-bugs.rst file. 377 + problem. If it's a kernel crash then you should refer to 378 + 'Documentation/admin-guide/reporting-issues.rst'. 379 379 380 380 But for most problems it is useful to provide the following: 381 381
+4 -5
Documentation/process/howto.rst
··· 348 348 349 349 https://bugzilla.kernel.org/page.cgi?id=faq.html 350 350 351 - The file :ref:`admin-guide/reporting-bugs.rst <reportingbugs>` 352 - in the main kernel source directory has a good 353 - template for how to report a possible kernel bug, and details what kind 354 - of information is needed by the kernel developers to help track down the 355 - problem. 351 + The file 'Documentation/admin-guide/reporting-issues.rst' in the main kernel 352 + source directory has a good template for how to report a possible kernel bug, 353 + and details what kind of information is needed by the kernel developers to help 354 + track down the problem. 356 355 357 356 358 357 Managing bug reports