blob: f543eaf4eb1d7f744995e2fb7e2fa73fcf2b823d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
# Copyright 2016-2024 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: 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=8
# 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
7|8) ;;
*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
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
|
