From: Zbigniew Jędrzejewski-Szmek Date: Sat, 29 Feb 2020 08:57:06 +0000 (+0100) Subject: man: add .service suffix to systemd-pstore(8) X-Git-Tag: v245-rc2~23^2~1 X-Git-Url: http://git-history.diyao.me/?a=commitdiff_plain;h=aa07dc70932837bfeda982affe53f01d36ec6efe;p=systemd%2F.git man: add .service suffix to systemd-pstore(8) That is the pattern that we always use with executables not in $PATH. --- diff --git a/man/rules/meson.build b/man/rules/meson.build index 5fe6df6272..6b08add2bb 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -772,7 +772,7 @@ manpages = [ ['systemd-nspawn', '1', [], ''], ['systemd-path', '1', [], ''], ['systemd-portabled.service', '8', ['systemd-portabled'], 'ENABLE_PORTABLED'], - ['systemd-pstore', '8', ['systemd-pstore.service'], 'ENABLE_PSTORE'], + ['systemd-pstore.service', '8', ['systemd-pstore'], 'ENABLE_PSTORE'], ['systemd-quotacheck.service', '8', ['systemd-quotacheck'], diff --git a/man/systemd-pstore.service.xml b/man/systemd-pstore.service.xml new file mode 100644 index 0000000000..47916da521 --- /dev/null +++ b/man/systemd-pstore.service.xml @@ -0,0 +1,99 @@ + + + + + + + + systemd-pstore.service + systemd + + + + systemd-pstore.service + 8 + + + + systemd-pstore.service + systemd-pstore + A service to archive contents of pstore + + + + /usr/lib/systemd/systemd-pstore + systemd-pstore.service + + + + Description + systemd-pstore.service is a system service that archives the + contents of the Linux persistent storage filesystem, pstore, to other storage, + thus preserving the existing information contained in the pstore, and clearing + pstore storage for future error events. + + Linux provides a persistent storage file system, pstore, that can store + error records when the kernel dies (or reboots or powers-off). These records in + turn can be referenced to debug kernel problems (currently the kernel stuffs + the tail of the dmesg, which also contains a stack backtrace, into pstore). + + The pstore file system supports a variety of backends that map onto persistent + storage, such as the ACPI ERST and UEFI variables. The pstore backends + typically offer a relatively small amount of persistent storage, e.g. 64KiB, + which can quickly fill up and thus prevent subsequent kernel crashes from + recording errors. Thus there is a need to monitor and extract the pstore + contents so that future kernel problems can also record information in the + pstore. + + The pstore service is independent of the kdump service. In cloud environments + specifically, host and guest filesystems are on remote filesystems (eg. iSCSI + or NFS), thus kdump relies (implicitly and/or explicitly) upon proper operation + of networking software *and* hardware *and* infrastructure. Thus it may not be + possible to capture a kernel coredump to a file since writes over the network + may not be possible. + + The pstore backend, on the other hand, is completely local and provides a path + to store error records which will survive a reboot and aid in post-mortem + debugging. + + The systemd-pstore executable does the actual work. Upon starting, + the pstore.conf file is read and the /sys/fs/pstore + directory contents are processed according to the options. Pstore files are written to the + journal, and optionally saved into /var/lib/systemd/pstore. + + + + Configuration + + The behavior of systemd-pstore is configured through the configuration file + /etc/systemd/pstore.conf and corresponding snippets + /etc/systemd/pstore.conf.d/*.conf, see + pstore.conf5. + + + + Disabling pstore processing + + To disable pstore processing by systemd-pstore, + set Storage=none in + pstore.conf5. + + + + + + Usage + Data stored in the journal can be viewed with + journalctl1 + as usual. + + + + See Also + + pstore.conf5 + + + diff --git a/man/systemd-pstore.xml b/man/systemd-pstore.xml deleted file mode 100644 index 14dd72262d..0000000000 --- a/man/systemd-pstore.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - systemd-pstore - systemd - - - - systemd-pstore - 8 - - - - systemd-pstore - systemd-pstore.service - Tool to archive contents of the persistent storage filesystem - - - - /usr/lib/systemd/systemd-pstore - systemd-pstore.service - - - - Description - systemd-pstore.service is a system service that archives the - contents of the Linux persistent storage filesystem, pstore, to other storage, - thus preserving the existing information contained in the pstore, and clearing - pstore storage for future error events. - - Linux provides a persistent storage file system, pstore, that can store - error records when the kernel dies (or reboots or powers-off). These records in - turn can be referenced to debug kernel problems (currently the kernel stuffs - the tail of the dmesg, which also contains a stack backtrace, into pstore). - - The pstore file system supports a variety of backends that map onto persistent - storage, such as the ACPI ERST and UEFI variables. The pstore backends - typically offer a relatively small amount of persistent storage, e.g. 64KiB, - which can quickly fill up and thus prevent subsequent kernel crashes from - recording errors. Thus there is a need to monitor and extract the pstore - contents so that future kernel problems can also record information in the - pstore. - - The pstore service is independent of the kdump service. In cloud environments - specifically, host and guest filesystems are on remote filesystems (eg. iSCSI - or NFS), thus kdump relies (implicitly and/or explicitly) upon proper operation - of networking software *and* hardware *and* infrastructure. Thus it may not be - possible to capture a kernel coredump to a file since writes over the network - may not be possible. - - The pstore backend, on the other hand, is completely local and provides a path - to store error records which will survive a reboot and aid in post-mortem - debugging. - - The systemd-pstore executable does the actual work. Upon starting, - the pstore.conf file is read and the /sys/fs/pstore - directory contents are processed according to the options. Pstore files are written to the - journal, and optionally saved into /var/lib/systemd/pstore. - - - - Configuration - - The behavior of systemd-pstore is configured through the configuration file - /etc/systemd/pstore.conf and corresponding snippets - /etc/systemd/pstore.conf.d/*.conf, see - pstore.conf5. - - - - Disabling pstore processing - - To disable pstore processing by systemd-pstore, - set Storage=none in - pstore.conf5. - - - - - - Usage - Data stored in the journal can be viewed with - journalctl1 - as usual. - - - - See Also - - pstore.conf5 - - -