Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit afeb000e authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

REPORTING-BUGS: convert to ReST markup 



- add a title to the document;
- use :: before verbatim blocks;
- add blank lines where required;
- use protocol for URL references;
- use a verbatim block for the bugs template;
- add cross references to SecurityBugs.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 8c287de3

REPORTING-BUGS

+38 −30
Original line number Original line Diff line number Diff line 
.. _reportingbugs:



Reporting bugs

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



Background

Background

==========

==========
@@ -50,12 +55,13 @@ maintainer replies to you, make sure to 'Reply-all' in order to keep the 
public mailing list(s) in the email thread.

public mailing list(s) in the email thread.





If you know which driver is causing issues, you can pass one of the driver

If you know which driver is causing issues, you can pass one of the driver

files to the get_maintainer.pl script:

files to the get_maintainer.pl script::



     perl scripts/get_maintainer.pl -f <filename>

     perl scripts/get_maintainer.pl -f <filename>





If it is a security bug, please copy the Security Contact listed in the

If it is a security bug, please copy the Security Contact listed in the

MAINTAINERS file.  They can help coordinate bugfix and disclosure.  See

MAINTAINERS file.  They can help coordinate bugfix and disclosure.  See

Documentation/SecurityBugs for more information.

:ref:`Documentation/SecurityBugs <securitybugs>` for more information.





If you can't figure out which subsystem caused the issue, you should file

If you can't figure out which subsystem caused the issue, you should file

a bug in kernel.org bugzilla and send email to

a bug in kernel.org bugzilla and send email to
@@ -70,6 +76,7 @@ Tips for reporting bugs 
If you haven't reported a bug before, please read:

If you haven't reported a bug before, please read:





	http://www.chiark.greenend.org.uk/~sgtatham/bugs.html

	http://www.chiark.greenend.org.uk/~sgtatham/bugs.html



	http://www.catb.org/esr/faqs/smart-questions.html

	http://www.catb.org/esr/faqs/smart-questions.html





It's REALLY important to report bugs that seem unrelated as separate email

It's REALLY important to report bugs that seem unrelated as separate email
@@ -99,11 +106,11 @@ relevant to your bug, feel free to exclude it. 




First run the ver_linux script included as scripts/ver_linux, which

First run the ver_linux script included as scripts/ver_linux, which

reports the version of some important subsystems.  Run this script with

reports the version of some important subsystems.  Run this script with

the command "sh scripts/ver_linux".

the command ``sh scripts/ver_linux``.





Use that information to fill in all fields of the bug report form, and

Use that information to fill in all fields of the bug report form, and

post it to the mailing list with a subject of "PROBLEM: <one line

post it to the mailing list with a subject of "PROBLEM: <one line

summary from [1.]>" for easy identification by the developers.

summary from [1.]>" for easy identification by the developers::





  [1.] One line summary of the problem:

  [1.] One line summary of the problem:

  [2.] Full description of the problem/report:

  [2.] Full description of the problem/report:
@@ -153,7 +160,8 @@ Expectations for kernel maintainers 
Linux kernel maintainers are busy, overworked human beings.  Some times

Linux kernel maintainers are busy, overworked human beings.  Some times

they may not be able to address your bug in a day, a week, or two weeks.

they may not be able to address your bug in a day, a week, or two weeks.

If they don't answer your email, they may be on vacation, or at a Linux

If they don't answer your email, they may be on vacation, or at a Linux

conference.  Check the conference schedule at LWN.net for more info:

conference.  Check the conference schedule at https://LWN.net for more info:



	https://lwn.net/Calendar/

	https://lwn.net/Calendar/





In general, kernel maintainers take 1 to 5 business days to respond to

In general, kernel maintainers take 1 to 5 business days to respond to