Commit 44ac5aba authored by Vegard Nossum's avatar Vegard Nossum Committed by Greg Kroah-Hartman
Browse files

Documentation/security-bugs: move from admin-guide/ to process/ 

Jiri Kosina, Jonathan Corbet, and Willy Tarreau all expressed a desire
to move this document under process/.

Create a new section for security issues in the index and group it with
embargoed-hardware-issues.

I'm doing this at the start of the series to make all the subsequent
changes show up in 'git blame'.

Existing references were updated using:

  git grep -l security-bugs ':!Documentation/translations/' | xargs sed -i 's|admin-guide/security-bugs|process/security-bugs|g'
  git grep -l security-bugs Documentation/translations/ | xargs sed -i 's|Documentation/admin-guide/security-bugs|Documentation/process/security-bugs|g'
  git grep -l security-bugs Documentation/translations/ | xargs sed -i '/Original:/s|\.\./admin-guide/security-bugs|\.\./process/security-bugs|g'

Notably, the page is not moved in the translations (due to my lack of
knowledge of these languages), but the translations have been updated
to point to the new location of the original document where these
references exist.

Link: https://lore.kernel.org/all/nycvar.YFH.7.76.2206062326230.10851@cbobk.fhfr.pm/


Suggested-by: default avatarJiri Kosina <jikos@kernel.org>
Cc: Alex Shi <alexs@kernel.org>
Cc: Yanteng Si <siyanteng@loongson.cn>
Cc: Hu Haowen <src.res@email.cn>
Cc: Federico Vaga <federico.vaga@vaga.pv.it>
Cc: Tsugikazu Shibata <tshibata@ab.jp.nec.com>
Cc: Minchan Kim <minchan@kernel.org>
Cc: Jeimi Lee <jamee.lee@samsung.com>
Cc: Carlos Bilbao <carlos.bilbao@amd.com>
Cc: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: default avatarVegard Nossum <vegard.nossum@oracle.com>
Acked-by: default avatarCarlos Bilbao <carlos.bilbao@amd.com>
Reviewed-by: default avatarYanteng Si <siyanteng@loongson.cn>
Reviewed-by: default avatarAkira Yokosawa <akiyks@gmail.com>
Acked-by: default avatarFederico Vaga <federico.vaga@vaga.pv.it>
Reviewed-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20230305220010.20895-2-vegard.nossum@oracle.com


Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent ec738ca1

Documentation/admin-guide/index.rst

+0 −1
Original line number Diff line number Diff line
@@ -36,7 +36,6 @@ problems and bugs in particular. 


   reporting-issues

   reporting-regressions

   security-bugs

   bug-hunting

   bug-bisect

   tainted-kernels

Documentation/admin-guide/reporting-issues.rst

+2 −2
Original line number Diff line number Diff line
@@ -395,7 +395,7 @@ might want to be aware of; it for example explains how to add your issue to the 
list of tracked regressions, to ensure it won't fall through the cracks.



What qualifies as security issue is left to your judgment. Consider reading

Documentation/admin-guide/security-bugs.rst before proceeding, as it

Documentation/process/security-bugs.rst before proceeding, as it

provides additional details how to best handle security issues.



An issue is a 'really severe problem' when something totally unacceptably bad
@@ -1269,7 +1269,7 @@ them when sending the report by mail. If you filed it in a bug tracker, forward 
the report's text to these addresses; but on top of it put a small note where

you mention that you filed it with a link to the ticket.



See Documentation/admin-guide/security-bugs.rst for more information.

See Documentation/process/security-bugs.rst for more information.





Duties after the report went out

Documentation/process/howto.rst

+1 −1
Original line number Diff line number Diff line
@@ -138,7 +138,7 @@ required reading: 
    philosophy and is very important for people moving to Linux from

    development on other Operating Systems.



  :ref:`Documentation/admin-guide/security-bugs.rst <securitybugs>`

  :ref:`Documentation/process/security-bugs.rst <securitybugs>`

    If you feel you have found a security problem in the Linux kernel,

    please follow the steps in this document to help notify the kernel

    developers, and help solve the issue.

Documentation/process/index.rst

+8 −1
Original line number Diff line number Diff line
@@ -35,6 +35,14 @@ Below are the essential guides that every developer should read. 
   kernel-enforcement-statement

   kernel-driver-statement



For security issues, see:



.. toctree::

   :maxdepth: 1



   security-bugs

   embargoed-hardware-issues



Other guides to the community that are of interest to most developers are:



.. toctree::
@@ -47,7 +55,6 @@ Other guides to the community that are of interest to most developers are: 
   submit-checklist

   kernel-docs

   deprecated

   embargoed-hardware-issues

   maintainers

   researcher-guidelines

Documentation/process/researcher-guidelines.rst

+1 −1
Original line number Diff line number Diff line
@@ -68,7 +68,7 @@ Before contributing, carefully read the appropriate documentation: 
* Documentation/process/development-process.rst

* Documentation/process/submitting-patches.rst

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

* Documentation/admin-guide/security-bugs.rst

* Documentation/process/security-bugs.rst



Then send a patch (including a commit log with all the details listed

below) and follow up on any feedback from other developers.