* [PATCH] Documentation: sysrq: fix RST formatting
@ 2020-04-03 17:07 Alyssa Ross
2020-04-07 19:32 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Alyssa Ross @ 2020-04-03 17:07 UTC (permalink / raw)
To: linux-doc; +Cc: linux-kernel, Jonathan Corbet, Alyssa Ross
"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 <hi@alyssa.is>
---
Documentation/admin-guide/sysrq.rst | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/Documentation/admin-guide/sysrq.rst b/Documentation/admin-guide/sysrq.rst
index 72b2cfb066f4..a46209f4636c 100644
--- a/Documentation/admin-guide/sysrq.rst
+++ b/Documentation/admin-guide/sysrq.rst
@@ -48,9 +48,10 @@ always allowed (by a user with admin privileges).
How do I use the magic SysRq key?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-On x86 - You press the key combo :kbd:`ALT-SysRq-<command key>`.
+On x86
+ You press the key combo :kbd:`ALT-SysRq-<command key>`.
-.. note::
+ .. note::
Some
keyboards may not have a key labeled 'SysRq'. The 'SysRq' key is
also known as the 'Print Screen' key. Also some keyboards cannot
@@ -58,14 +59,15 @@ On x86 - You press the key combo :kbd:`ALT-SysRq-<command key>`.
have better luck with press :kbd:`Alt`, press :kbd:`SysRq`,
release :kbd:`SysRq`, press :kbd:`<command key>`, release everything.
-On SPARC - You press :kbd:`ALT-STOP-<command key>`, I believe.
+On SPARC
+ You press :kbd:`ALT-STOP-<command key>`, I believe.
On the serial console (PC style standard serial ports only)
You send a ``BREAK``, then within 5 seconds a command key. Sending
``BREAK`` twice is interpreted as a normal BREAK.
On PowerPC
- Press :kbd:`ALT - Print Screen` (or :kbd:`F13`) - :kbd:`<command key>`,
+ Press :kbd:`ALT - Print Screen` (or :kbd:`F13`) - :kbd:`<command key>`.
:kbd:`Print Screen` (or :kbd:`F13`) - :kbd:`<command key>` may suffice.
On other
@@ -73,7 +75,7 @@ On other
let me know so I can add them to this section.
On all
- write a character to /proc/sysrq-trigger. e.g.::
+ Write a character to /proc/sysrq-trigger. e.g.::
echo t > /proc/sysrq-trigger
@@ -282,7 +284,7 @@ Just ask them on the linux-kernel mailing list:
Credits
~~~~~~~
-Written by Mydraal <vulpyne@vulpyne.net>
-Updated by Adam Sulmicki <adam@cfar.umd.edu>
-Updated by Jeremy M. Dolan <jmd@turbogeek.org> 2001/01/28 10:15:59
-Added to by Crutcher Dunnavant <crutcher+kernel@datastacks.com>
+- Written by Mydraal <vulpyne@vulpyne.net>
+- Updated by Adam Sulmicki <adam@cfar.umd.edu>
+- Updated by Jeremy M. Dolan <jmd@turbogeek.org> 2001/01/28 10:15:59
+- Added to by Crutcher Dunnavant <crutcher+kernel@datastacks.com>
--
2.24.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: sysrq: fix RST formatting
2020-04-03 17:07 [PATCH] Documentation: sysrq: fix RST formatting Alyssa Ross
@ 2020-04-07 19:32 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2020-04-07 19:32 UTC (permalink / raw)
To: Alyssa Ross; +Cc: linux-doc, linux-kernel
On Fri, 3 Apr 2020 17:07:01 +0000
Alyssa Ross <hi@alyssa.is> wrote:
> "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 <hi@alyssa.is>
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-04-07 19:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-04-03 17:07 [PATCH] Documentation: sysrq: fix RST formatting Alyssa Ross
2020-04-07 19:32 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).