summaryrefslogtreecommitdiff
path: root/man/coredump.conf.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/coredump.conf.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/coredump.conf.xml')
-rw-r--r--man/coredump.conf.xml10
1 files changed, 7 insertions, 3 deletions
diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml
index 048bbc3637..49debb219a 100644
--- a/man/coredump.conf.xml
+++ b/man/coredump.conf.xml
@@ -74,7 +74,7 @@
<listitem><para>Controls where to store cores. One of <literal>none</literal>,
<literal>external</literal>, and <literal>journal</literal>. When
- <literal>none</literal>, the core dumps will be logged (including the backtrace if
+ <literal>none</literal>, the core dumps may be logged (including the backtrace if
possible), but not stored permanently. When <literal>external</literal> (the
default), cores will be stored in <filename>/var/lib/systemd/coredump/</filename>.
When <literal>journal</literal>, cores will be stored in the journal and rotated
@@ -101,8 +101,12 @@
<listitem><para>The maximum size in bytes of a core
which will be processed. Core dumps exceeding this size
- will be logged, but the backtrace will not be generated
- and the core will not be stored.</para></listitem>
+ may be stored, but the backtrace will not be generated.
+ </para>
+
+ <para>Setting <varname>Storage=none</varname> and <varname>ProcessSizeMax=0</varname>
+ disables all coredump handling except for a log entry.</para>
+ </listitem>
</varlistentry>
<varlistentry>