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

Commit ed6e26ba authored by Christophe JAILLET's avatar Christophe JAILLET Committed by Jonathan Corbet
Browse files

bug-hunting.rst: Fix an example and a typo in a Sphinx tag 



- Use the same file name in the explanation and in the example (conex.c vs
sonixj.c)
- Add a missing ':' in a :ref: tag which leads to incorrect Shpinx output
- Add some missing ',' and ';'

Signed-off-by: default avatarChristophe JAILLET <christophe.jaillet@wanadoo.fr>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 45653c84

Documentation/admin-guide/bug-hunting.rst

+4 −4
Original line number Original line Diff line number Diff line
@@ -240,7 +240,7 @@ In order to report it upstream, you should identify the mailing list 
used for the development of the affected code. This can be done by using

used for the development of the affected code. This can be done by using

the ``get_maintainer.pl`` script.

the ``get_maintainer.pl`` script.





For example, if you find a bug at the gspca's conex.c file, you can get

For example, if you find a bug at the gspca's sonixj.c file, you can get

their maintainers with::

their maintainers with::





	$ ./scripts/get_maintainer.pl -f drivers/media/usb/gspca/sonixj.c

	$ ./scripts/get_maintainer.pl -f drivers/media/usb/gspca/sonixj.c
@@ -257,7 +257,7 @@ Please notice that it will point to: 
  Tejun and Bhaktipriya (in this specific case, none really envolved on the

  Tejun and Bhaktipriya (in this specific case, none really envolved on the

  development of this file);

  development of this file);

- The driver maintainer (Hans Verkuil);

- The driver maintainer (Hans Verkuil);

- The subsystem maintainer (Mauro Carvalho Chehab)

- The subsystem maintainer (Mauro Carvalho Chehab);

- The driver and/or subsystem mailing list (linux-media@vger.kernel.org);

- The driver and/or subsystem mailing list (linux-media@vger.kernel.org);

- the Linux Kernel mailing list (linux-kernel@vger.kernel.org).

- the Linux Kernel mailing list (linux-kernel@vger.kernel.org).
@@ -274,14 +274,14 @@ Fixing the bug 
--------------

--------------





If you know programming, you could help us by not only reporting the bug,

If you know programming, you could help us by not only reporting the bug,

but also providing us with a solution. After all open source is about

but also providing us with a solution. After all, open source is about

sharing what you do and don't you want to be recognised for your genius?

sharing what you do and don't you want to be recognised for your genius?





If you decide to take this way, once you have worked out a fix please submit

If you decide to take this way, once you have worked out a fix please submit

it upstream.

it upstream.





Please do read

Please do read

ref:`Documentation/process/submitting-patches.rst <submittingpatches>` though

:ref:`Documentation/process/submitting-patches.rst <submittingpatches>` though

to help your code get accepted.

to help your code get accepted.