summaryrefslogtreecommitdiffstats
path: root/Documentation/admin-guide/sysctl
Commit message (Collapse)AuthorAgeFilesLines
...
* | Documentation: Better document the softlockup_panic sysctlGuilherme G. Piccoli2020-03-101-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Commit 9c44bc03fff4 ("softlockup: allow panic on lockup") added the softlockup_panic sysctl, but didn't add information about it to the file Documentation/admin-guide/sysctl/kernel.rst (which in that time certainly wasn't rst and had other name!). This patch just adds the respective documentation and references it from the corresponding entry in Documentation/admin-guide/kernel-parameters.txt. This patch was strongly based on Scott Wood's commit d22881dc13b6 ("Documentation: Better document the hardlockup_panic sysctl"). Reviewed-by: Kees Cook <keescook@chromium.org> Signed-off-by: Guilherme G. Piccoli <gpiccoli@canonical.com> Link: https://lore.kernel.org/r/20200310183649.23163-1-gpiccoli@canonical.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: add a script to check sysctl docsStephen Kitt2020-02-251-0/+3
| | | | | | | | | | | | | | | | | | | | This script allows sysctl documentation to be checked against the kernel source code, to identify missing or obsolete entries. Running it against 5.5 shows for example that sysctl/kernel.rst has two obsolete entries and is missing 52 entries. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: sysctl/kernel: document acpi_video_flagsStephen Kitt2020-02-251-2/+9
| | | | | | | | | | | | | | | | Based on the implementation in arch/x86/kernel/acpi/sleep.c, in particular the acpi_sleep_setup() function. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: sysctl/kernel: remove rtsig entriesStephen Kitt2020-02-191-10/+0
| | | | | | | | | | | | | | These have no corresponding code in the kernel. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: document panic fully in sysctl/kernel.rstStephen Kitt2020-02-191-3/+9
| | | | | | | | | | | | | | | | | | | | | | The description of panic doesn’t cover all the supported scenarios; this patch fixes that, describing the three possibilities (no reboot, immediate reboot, reboot after a delay). Based on the implementation in kernel/panic.c. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: document stop-a in sysctl/kernel.rstStephen Kitt2020-02-191-0/+10
| | | | | | | | | | | | | | | | | | | | | | This describes the SPARC-specific stop-a sysctl entry, which was previously listed in kernel.rst but not documented. Base on the implementation in arch/sparc/kernel/setup_{32,64}.c and kernel/panic.c. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: add missing IPC documentation in sysctl/kernel.rstStephen Kitt2020-02-191-0/+12
| | | | | | | | | | | | | | | | This adds short descriptions of msgmax, msgmnb, msgmni, and shmmni, which were previously listed in kernel.rst but not described. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: drop l2cr from sysctl/kernel.rstStephen Kitt2020-02-191-7/+0
| | | | | | | | | | | | | | | | | | The l2cr sysctl entry was removed in commit c2f3dabefa73 ("sysctl: kill binary sysctl KERN_PPC_L2CR"), this removes the corresponding documentation. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: merge debugging-modules.txt into sysctl/kernel.rstStephen Kitt2020-02-191-1/+13
| | | | | | | | | | | | | | | | This fits nicely in sysctl/kernel.rst, merge it (and rephrase it) instead of linking to it. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: pretty up sysctl/kernel.rstStephen Kitt2020-02-191-495/+492
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This updates sysctl/kernel.rst to use ReStructured Text more fully: * the list of files is now the table of contents (old entries with no corresponding sections are added as empty sections for now); * code references and commands are formatted as code, except for function names which end up linked to the appropriate documentation; * links are used to point to other documentation and other sections; * tables are used to make lists of values more readable (as already done for some sections); * in heavily-reworked paragraphs, sentences are wrapped individually, to make future diffs easier to read. The first mention of the kernel version is dropped. The second mention, saying that the document is accurate for 2.2, is preserved for now; I will update that once the document really is accurate for a current kernel release. Signed-off-by: Stephen Kitt <steve@sk2.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* | docs: admin-guide: Add description of %c corename formatd.hatayama@fujitsu.com2020-02-131-0/+1
|/ | | | | | | | | | | | | | There is somehow no description of %c corename format specifier for /proc/sys/kernel/core_pattern. The %c corename format specifier is used by user-space application such as systemd-coredump, so it should be documented. To find where %c is handled in the kernel source code, look at function format_corename() in fs/coredump.c. Signed-off-by: HATAYAMA Daisuke <d.hatayama@fujitsu.com> Link: https://lore.kernel.org/r/TYAPR01MB4014714BB2ACE425BB6EC6B7951A0@TYAPR01MB4014.jpnprd01.prod.outlook.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: Remove threads-max auto-tuningMasanari Iida2019-11-071-4/+0
| | | | | | | | | | | | | | Since following path was merged in 5.4-rc3, auto-tuning feature in threads-max does not exist any more. Fix the admin-guide document as is. kernel/sysctl.c: do not override max_threads provided by userspace b0f53dbc4bc4c371f38b14c391095a3bb8a0bb40 Fixes: b0f53dbc4bc4 ("kernel/sysctl.c: do not override max_threads provided by userspace") Signed-off-by: Masanari Iida <standby24x7@gmail.com> Acked-by: Michal Hocko <mhocko@suse.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: Fix min value of threads-max in kernel.rstMasanari Iida2019-11-071-1/+1
| | | | | | | | | | | | | Since following patch was merged 5.4-rc3, minimum value for threads-max changed to 1. kernel/sysctl.c: do not override max_threads provided by userspace b0f53dbc4bc4c371f38b14c391095a3bb8a0bb40 Fixes: b0f53dbc4bc4 ("kernel/sysctl.c: do not override max_threads provided by userspace") Signed-off-by: Masanari Iida <standby24x7@gmail.com> Acked-by: Michal Hocko <mhocko@suse.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: fix printk_ratelimit explanationOleksandr Natalenko2019-10-101-2/+4
| | | | | | | | | | | | | | | The printk_ratelimit value accepts seconds, not jiffies (though it is converted into jiffies internally). Update documentation to reflect this. Also, remove the statement about allowing 1 message in 5 seconds since bursts up to 10 messages are allowed by default. Finally, while we are here, mention default value for printk_ratelimit_burst too. Signed-off-by: Oleksandr Natalenko <oleksandr@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: remove references to IPX and token-ringStephen Hemminger2019-08-081-28/+1
| | | | | | | | Both IPX and TR have not been supported for a while now. Remove them from the /proc/sys/net documentation. Signed-off-by: Stephen Hemminger <stephen@networkplumber.org> Signed-off-by: David S. Miller <davem@davemloft.net>
* docs: admin-guide: add a series of orphaned documentsMauro Carvalho Chehab2019-07-151-1/+1
| | | | | | | | | | | There are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir). Move them to the admin guide. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Alexandre Belloni <alexandre.belloni@bootlin.com> Acked-by: Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>
* docs: admin-guide: add laptops documentationMauro Carvalho Chehab2019-07-151-2/+2
| | | | | | | | The docs under Documentation/laptops contain users specific information. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>
* docs: admin-guide: move sysctl directory to itMauro Carvalho Chehab2019-07-158-0/+3254
The stuff under sysctl describes /sys interface from userspace point of view. So, add it to the admin-guide and remove the :orphan: from its index file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>