You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
149 lines
3.8 KiB
149 lines
3.8 KiB
# Copyright 2016-2022 Gentoo Authors
|
|
# Distributed under the terms of the GNU General Public License v2
|
|
|
|
# @ECLASS: tmpfiles.eclass
|
|
# @MAINTAINER:
|
|
# Gentoo systemd project <systemd@gentoo.org>
|
|
# William Hubbs <williamh@gentoo.org>
|
|
# @AUTHOR:
|
|
# Mike Gilbert <floppym@gentoo.org>
|
|
# William Hubbs <williamh@gentoo.org>
|
|
# @SUPPORTED_EAPIS: 5 6 7 8
|
|
# @BLURB: Functions related to tmpfiles.d files
|
|
# @DESCRIPTION:
|
|
# This eclass provides functionality related to installing and
|
|
# creating volatile and temporary files based on configuration files$and
|
|
# locations defined at this URL:
|
|
#
|
|
# https://www.freedesktop.org/software/systemd/man/tmpfiles.d.html
|
|
#
|
|
# The dotmpfiles and newtmpfiles functions are used to install
|
|
# configuration files into /usr/lib/tmpfiles.d, then in pkg_postinst,
|
|
# the tmpfiles_process function must be called to process the newly
|
|
# installed tmpfiles.d entries.
|
|
#
|
|
# The tmpfiles.d files can be used by service managers to recreate/clean
|
|
# up temporary directories on boot or periodically. Additionally,
|
|
# the pkg_postinst() call ensures that the directories are created
|
|
# on systems that do not support tmpfiles.d natively, without a need
|
|
# for explicit fallback.
|
|
#
|
|
# @EXAMPLE:
|
|
# Typical usage of this eclass:
|
|
#
|
|
# @CODE
|
|
# EAPI=6
|
|
# inherit tmpfiles
|
|
#
|
|
# ...
|
|
#
|
|
# src_install() {
|
|
# ...
|
|
# dotmpfiles "${FILESDIR}"/file1.conf "${FILESDIR}"/file2.conf
|
|
# newtmpfiles "${FILESDIR}"/file3.conf-${PV} file3.conf
|
|
# ...
|
|
# }
|
|
#
|
|
# pkg_postinst() {
|
|
# ...
|
|
# tmpfiles_process file1.conf file2.conf file3.conf
|
|
# ...
|
|
# }
|
|
#
|
|
# @CODE
|
|
|
|
if [[ -z ${_TMPFILES_ECLASS} ]]; then
|
|
_TMPFILES_ECLASS=1
|
|
|
|
case "${EAPI}" in
|
|
5|6|7|8) ;;
|
|
*) die "API is undefined for EAPI ${EAPI}" ;;
|
|
esac
|
|
|
|
# @ECLASS_VARIABLE: TMPFILES_OPTIONAL
|
|
# @PRE_INHERIT
|
|
# @DEFAULT_UNSET
|
|
# @DESCRIPTION:
|
|
# When not empty, disables the dependency on virtual/tmpfiles.
|
|
# Ebuilds that call tmpfiles_process conditionally should declare a
|
|
# conditional dependency themselves.
|
|
if [[ -z ${TMPFILES_OPTIONAL} ]]; then
|
|
RDEPEND="virtual/tmpfiles"
|
|
fi
|
|
|
|
# @FUNCTION: dotmpfiles
|
|
# @USAGE: <tmpfiles.d_file> ...
|
|
# @DESCRIPTION:
|
|
# Install one or more tmpfiles.d files into /usr/lib/tmpfiles.d.
|
|
dotmpfiles() {
|
|
debug-print-function "${FUNCNAME}" "$@"
|
|
|
|
local f
|
|
for f; do
|
|
if [[ ${f} != *.conf ]]; then
|
|
die "tmpfiles.d files must end with .conf"
|
|
fi
|
|
done
|
|
|
|
(
|
|
insopts -m 0644
|
|
insinto /usr/lib/tmpfiles.d
|
|
doins "$@"
|
|
)
|
|
}
|
|
|
|
# @FUNCTION: newtmpfiles
|
|
# @USAGE: <old-name> <new-name>.conf
|
|
# @DESCRIPTION:
|
|
# Install a tmpfiles.d file in /usr/lib/tmpfiles.d under a new name.
|
|
newtmpfiles() {
|
|
debug-print-function "${FUNCNAME}" "$@"
|
|
|
|
if [[ $2 != *.conf ]]; then
|
|
die "tmpfiles.d files must end with .conf"
|
|
fi
|
|
|
|
(
|
|
insopts -m 0644
|
|
insinto /usr/lib/tmpfiles.d
|
|
newins "$@"
|
|
)
|
|
}
|
|
|
|
# @FUNCTION: tmpfiles_process
|
|
# @USAGE: <filename> <filename> ...
|
|
# @DESCRIPTION:
|
|
# Call a tmpfiles.d implementation to create new volatile and temporary
|
|
# files and directories.
|
|
tmpfiles_process() {
|
|
debug-print-function "${FUNCNAME}" "$@"
|
|
|
|
[[ ${EBUILD_PHASE} == postinst ]] || die "${FUNCNAME}: Only valid in pkg_postinst"
|
|
[[ ${#} -gt 0 ]] || die "${FUNCNAME}: Must specify at least one filename"
|
|
|
|
# Only process tmpfiles for the currently running system
|
|
if [[ ${ROOT:-/} != / ]]; then
|
|
ewarn "Warning: tmpfiles.d not processed on ROOT != /. If you do not use"
|
|
ewarn "a service manager supporting tmpfiles.d, you need to run"
|
|
ewarn "the following command after booting (or chroot-ing with all"
|
|
ewarn "appropriate filesystems mounted) into the ROOT:"
|
|
ewarn
|
|
ewarn " tmpfiles --create"
|
|
ewarn
|
|
ewarn "Failure to do so may result in missing runtime directories"
|
|
ewarn "and failures to run programs or start services."
|
|
return
|
|
fi
|
|
|
|
if type systemd-tmpfiles &> /dev/null; then
|
|
systemd-tmpfiles --create "$@"
|
|
elif type tmpfiles &> /dev/null; then
|
|
tmpfiles --create "$@"
|
|
fi
|
|
if [[ $? -ne 0 ]]; then
|
|
ewarn "The tmpfiles processor exited with a non-zero exit code"
|
|
fi
|
|
}
|
|
|
|
fi
|