Skip to content

Commit 8699039

Browse files
alyssaisJonathan Corbet
authored andcommitted
Documentation: sysrq: fix RST formatting
"On x86" and "On SPARC" are now definition list terms, like "On PowerPC", "On other", and "On all". The Credits list is now a bulleted list, like lots of Credits lists in other files. This prevents the list from becoming a single long, unpunctuated sentence in the generated documentation. I also did a couple of other tiny readability improvements to the "How do I use the magic SysRq key?" section while I was there. Signed-off-by: Alyssa Ross <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent cd4ca34 commit 8699039

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

Documentation/admin-guide/sysrq.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,32 +48,34 @@ always allowed (by a user with admin privileges).
4848
How do I use the magic SysRq key?
4949
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5050

51-
On x86 - You press the key combo :kbd:`ALT-SysRq-<command key>`.
51+
On x86
52+
You press the key combo :kbd:`ALT-SysRq-<command key>`.
5253

53-
.. note::
54+
.. note::
5455
Some
5556
keyboards may not have a key labeled 'SysRq'. The 'SysRq' key is
5657
also known as the 'Print Screen' key. Also some keyboards cannot
5758
handle so many keys being pressed at the same time, so you might
5859
have better luck with press :kbd:`Alt`, press :kbd:`SysRq`,
5960
release :kbd:`SysRq`, press :kbd:`<command key>`, release everything.
6061

61-
On SPARC - You press :kbd:`ALT-STOP-<command key>`, I believe.
62+
On SPARC
63+
You press :kbd:`ALT-STOP-<command key>`, I believe.
6264

6365
On the serial console (PC style standard serial ports only)
6466
You send a ``BREAK``, then within 5 seconds a command key. Sending
6567
``BREAK`` twice is interpreted as a normal BREAK.
6668

6769
On PowerPC
68-
Press :kbd:`ALT - Print Screen` (or :kbd:`F13`) - :kbd:`<command key>`,
70+
Press :kbd:`ALT - Print Screen` (or :kbd:`F13`) - :kbd:`<command key>`.
6971
:kbd:`Print Screen` (or :kbd:`F13`) - :kbd:`<command key>` may suffice.
7072

7173
On other
7274
If you know of the key combos for other architectures, please
7375
let me know so I can add them to this section.
7476

7577
On all
76-
write a character to /proc/sysrq-trigger. e.g.::
78+
Write a character to /proc/sysrq-trigger. e.g.::
7779

7880
echo t > /proc/sysrq-trigger
7981

@@ -282,7 +284,7 @@ Just ask them on the linux-kernel mailing list:
282284
Credits
283285
~~~~~~~
284286

285-
Written by Mydraal <[email protected]>
286-
Updated by Adam Sulmicki <[email protected]>
287-
Updated by Jeremy M. Dolan <[email protected]> 2001/01/28 10:15:59
288-
Added to by Crutcher Dunnavant <[email protected]>
287+
- Written by Mydraal <[email protected]>
288+
- Updated by Adam Sulmicki <[email protected]>
289+
- Updated by Jeremy M. Dolan <[email protected]> 2001/01/28 10:15:59
290+
- Added to by Crutcher Dunnavant <[email protected]>

0 commit comments

Comments
 (0)