Skip to contentSkip to conversation

Documentation: sysrq: convert to third person

PATCH In review Cengiz Can 2 participants 2 messages Jun 29, 2021 – Jul 12, 2021 Documentation

lore
Share & tools
lore

Cengiz Can

author
#0 lore raw

PATCH 1/1 Documentation: sysrq: convert to third person

Two parts of the sysrq documentation have sentences written from a first person's point of view.

Documentation is generally written from a third person's view in a formal way.

Convert those senteces to be less personal and generic.

---
 Documentation/admin-guide/sysrq.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
Documentation/admin-guide/sysrq.rst +7 -5
index 60ce5f5ebab6..0a178ef0111d 100644
@@ -72,7 +72,7 @@ On PowerPC
 
 On other
 	If you know of the key combos for other architectures, please
-        let me know so I can add them to this section.
+	submit a patch to be included in this section.
 
 On all
 	Write a character to /proc/sysrq-trigger.  e.g.::
@@ -205,10 +205,12 @@ frozen (probably root) filesystem via the FIFREEZE ioctl.
 Sometimes SysRq seems to get 'stuck' after using it, what can I do?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-That happens to me, also. I've found that tapping shift, alt, and control
-on both sides of the keyboard, and hitting an invalid sysrq sequence again
-will fix the problem. (i.e., something like :kbd:`alt-sysrq-z`). Switching to
-another virtual console (:kbd:`ALT+Fn`) and then back again should also help.
+When this happens, try tapping shift, alt and control on both sides of the
+keyboard, and hitting an invalid sysrq sequence again. (i.e., something like
+:kbd:`alt-sysrq-z`).
+
+Switching to another virtual console (:kbd:`ALT+Fn`) and then back again
+should also help.
 
 I hit SysRq, but nothing seems to happen, what's wrong?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Signature · 1 line
2.32.0
maintainer
#1 lore raw
Quoted 7 lines · Cengiz Can

Two parts of the sysrq documentation have sentences written from a first person's point of view.

Documentation is generally written from a third person's view in a formal way.

Convert those senteces to be less personal and generic.

So this seems like a fine change, but I have one little gripe...

Quoted 22 lines
---
 Documentation/admin-guide/sysrq.rst | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)
Documentation/admin-guide/sysrq.rst +1 -1
index 60ce5f5ebab6..0a178ef0111d 100644
@@ -72,7 +72,7 @@ On PowerPC
 
 On other
 	If you know of the key combos for other architectures, please
-        let me know so I can add them to this section.
+	submit a patch to be included in this section.
 
 On all
 	Write a character to /proc/sysrq-trigger.  e.g.::
@@ -205,10 +205,12 @@ frozen (probably root) filesystem via the FIFREEZE ioctl.
 Sometimes SysRq seems to get 'stuck' after using it, what can I do?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

Documentation/admin-guide/sysrq.rst frozen (probably root) filesystem via the FIFREEZE ioctl. · line 213

Quoted 10 lines
Documentation/admin-guide/sysrq.rst +6 -4
-That happens to me, also. I've found that tapping shift, alt, and control
-on both sides of the keyboard, and hitting an invalid sysrq sequence again
-will fix the problem. (i.e., something like :kbd:`alt-sysrq-z`). Switching to
-another virtual console (:kbd:`ALT+Fn`) and then back again should also help.
+When this happens, try tapping shift, alt and control on both sides of the
+keyboard, and hitting an invalid sysrq sequence again. (i.e., something like
+:kbd:`alt-sysrq-z`).
+
+Switching to another virtual console (:kbd:`ALT+Fn`) and then back again
+should also help.

The :kbd: stuff is a pretty good example of the sort of extra markup we try to avoid when we can. It adds little to the formatted docs and worsens the reading experience for plain-text. It sure would be nice if we could make that kind of stuff go away when we're in the neighborhood.

Anyway, I've applied the patch.

Thanks,

jon