summaryrefslogtreecommitdiff
path: root/man/systemd-coredump.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-05-17 17:08:31 +0200
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2018-05-17 17:15:03 +0200
commitc8e053fbe4e7182d88e25477dced2c717f33fdfa (patch)
tree191771218beb46ef9f5e32eba82396251c2fcfd5 /man/systemd-coredump.xml
parentee0449fd7a5d4755d133cf0ddba8ddadc07f057e (diff)
downloadsystemd-c8e053fbe4e7182d88e25477dced2c717f33fdfa.tar.gz
man: fix ProcessSizeMax= description, describe how to disable coredumps
What the man page said was different than what the code did. save_external_coredump() will store the core temporarily for backtrace generation, and will delete if afterwards if it is too large. So to disable processing, it's necessary to both set Storage=none/Storage=journal+JournalSizeMax=0/Storage=external+ExternalSizeMax=0 and ProcessSizeMax=0. This updates the man page to reflect the code. The man pages are extended to describe that Storage=none + ProcessSizeMax=0 is the simplest way to disable coredump processing. All the storage and processing options make this quite complicated, so let's add a copy-and-pasteable example of how to disable coredump. Doing it through coredump.conf has the advantage that we still log, and the effect is immediate, unlike masking the sysconf file. Fixes #8788.
Diffstat (limited to 'man/systemd-coredump.xml')
-rw-r--r--man/systemd-coredump.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/man/systemd-coredump.xml b/man/systemd-coredump.xml
index 6c3078143f..6fba19c223 100644
--- a/man/systemd-coredump.xml
+++ b/man/systemd-coredump.xml
@@ -128,6 +128,16 @@
core dumps and files can be set in files <filename>/etc/systemd/coredump.conf</filename> and snippets mentioned
above. In addition the storage time of core dump files is restricted by <command>systemd-tmpfiles</command>,
corresponding settings are by default in <filename>/usr/lib/tmpfiles.d/systemd.conf</filename>.</para>
+
+ <refsect2>
+ <title>Disabling coredump processing</title>
+
+ <para>To disable potentially resource-intensive processing by <command>systemd-coredump</command>,
+ set <programlisting>Storage=none
+ProcessSizeMax=0</programlisting> in
+ <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+ </para>
+ </refsect2>
</refsect1>
<refsect1>