lwn.git/Documentation/admin-guide/sysrq.rst, branch docs-6.8

Documentation: admin-guide: correct spelling

2023-02-02T18:04:42+00:00

Correct spelling problems for Documentation/admin-guide/ as reported by codespell. Signed-off-by: Randy Dunlap Reviewed-by: Mukesh Ojha Cc: Tejun Heo Cc: Zefan Li Cc: Johannes Weiner Cc: cgroups@vger.kernel.org Cc: Alasdair Kergon Cc: Mike Snitzer Cc: dm-devel@redhat.com Cc: Mauro Carvalho Chehab Cc: linux-media@vger.kernel.org Cc: linux-mm@kvack.org Link: https://lore.kernel.org/r/20230129231053.20863-2-rdunlap@infradead.org Signed-off-by: Jonathan Corbet

Documentation: sysrq: convert to third person

2021-07-15T12:33:44+00:00

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. Signed-off-by: Cengiz Can Link: https://lore.kernel.org/r/20210629141508.52229-1-cengiz@kernel.wtf Signed-off-by: Jonathan Corbet

Documentation: sysrq: update description about sysrq crash

2021-03-15T20:23:21+00:00

After commit 8341f2f222d7 ("sysrq: Use panic() to force a crash"), a crash was not generated by dereferencing a NULL pointer anymore. Let's update documentation as well to make it less misleading. Signed-off-by: Gao Xiang Cc: Matthias Kaehlcke Cc: Greg Kroah-Hartman Cc: Jonathan Corbet Cc: Zefan Li Link: https://lore.kernel.org/r/20210309191550.3955601-1-hsiangkao@redhat.com Signed-off-by: Jonathan Corbet

tty/sysrq: Extend the sysrq_key_table to cover capital letters

2020-10-02T12:56:06+00:00

All slots in sysrq_key_table[] are either used, reserved or at least commented with their intended use. This patch adds capital letter versions available, which means adding 26 more entries. For already existing SysRq operations the user presses Alt-SysRq-, and for the newly added ones Alt-Shift-SysRq-. Signed-off-by: Andrzej Pietrasiewicz Acked-by: Daniel Vetter Link: https://lore.kernel.org/r/20200818112825.6445-2-andrzej.p@collabora.com Signed-off-by: Greg Kroah-Hartman

tty/sysrq: constify the sysrq API

2020-05-15T12:53:19+00:00

The user is not supposed to thinker with the underlying sysrq_key_op. Make that explicit by adding a handful of const notations. Cc: Greg Kroah-Hartman Cc: Jiri Slaby Cc: linux-kernel@vger.kernel.org Signed-off-by: Emil Velikov Link: https://lore.kernel.org/r/20200513214351.2138580-2-emil.l.velikov@gmail.com Signed-off-by: Greg Kroah-Hartman

Documentation: sysrq: fix RST formatting

2020-04-07T19:32:15+00:00

"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 Link: https://lore.kernel.org/r/20200403170701.10852-1-hi@alyssa.is Signed-off-by: Jonathan Corbet

Documentation: sysrq: don't recommend 'S' 'U' before 'B'

2019-09-06T14:42:52+00:00

This advice is obsolete and slightly harmful for filesystems from this millenium: any modern filesystem can handle unexpected crashes without requiring fsck -- and on the other hand, trying to write to the disk when the kernel is in a bad state risks introducing corruption. For ext2, any unsafe shutdown meant widespread breakage, but it's no longer a reasonable filesystem for any non-special use. Signed-off-by: Adam Borowski Signed-off-by: Jonathan Corbet

Documentation: admin-guide: fix path to input key definitions

2017-03-13T23:15:30+00:00

The UAPI header split failed to update the documentation here; fix things accordingly. Signed-off-by: Martin Kepplinger Signed-off-by: Jonathan Corbet

docs-rst: create an user's manual book

2016-10-24T10:12:35+00:00

Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters on an user's manual book. As we'll be numbering the user's manual, remove the manual numbering from SecurityBugs. Signed-off-by: Mauro Carvalho Chehab