eclass/udev.eclass

   1 # Copyright 1999-2014 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3
   4 # @ECLASS: udev.eclass
   5 # @MAINTAINER:
   6 # udev-bugs@gentoo.org
   7 # @BLURB: Default eclass for determining udev directories.
   8 # @DESCRIPTION:
   9 # Default eclass for determining udev directories.
  10 # @EXAMPLE:
  11 #
  12 # @CODE
  13 # inherit udev
  14 #
  15 # # Example of the eclass usage:
  16 # RDEPEND="virtual/udev"
  17 # DEPEND="${RDEPEND}"
  18 #
  19 # src_configure() {
  20 #       econf --with-rulesdir="$(get_udevdir)"/rules.d
  21 # }
  22 #
  23 # src_install() {
  24 #       default
  25 #       # udev_dorules contrib/99-foomatic
  26 #       # udev_newrules contrib/98-foomatic 99-foomatic
  27 # }
  28 # @CODE
  29
  30 if [[ -z ${_UDEV_ECLASS} ]]; then
  31 _UDEV_ECLASS=1
  32
  33 inherit toolchain-funcs
  34
  35 case ${EAPI:-0} in
  36         0|1|2|3|4|5|6) ;;
  37         *) die "${ECLASS}.eclass API in EAPI ${EAPI} not yet established."
  38 esac
  39
  40 RDEPEND=""
  41 DEPEND="virtual/pkgconfig"
  42
  43 # @FUNCTION: _udev_get_udevdir
  44 # @INTERNAL
  45 # @DESCRIPTION:
  46 # Get unprefixed udevdir.
  47 _udev_get_udevdir() {
  48         if $($(tc-getPKG_CONFIG) --exists udev); then
  49                 echo "$($(tc-getPKG_CONFIG) --variable=udevdir udev)"
  50         else
  51                 echo /lib/udev
  52         fi
  53 }
  54
  55 # @FUNCTION: udev_get_udevdir
  56 # @DESCRIPTION:
  57 # Use the short version $(get_udevdir) instead!
  58 udev_get_udevdir() {
  59         debug-print-function ${FUNCNAME} "${@}"
  60
  61         eerror "This ebuild should be using the get_udevdir() function instead of the deprecated udev_get_udevdir()"
  62         die "Deprecated function call: udev_get_udevdir(), please report to (overlay) maintainers."
  63 }
  64
  65 # @FUNCTION: get_udevdir
  66 # @DESCRIPTION:
  67 # Output the path for the udev directory (not including ${D}).
  68 # This function always succeeds, even if udev is not installed.
  69 # The fallback value is set to /lib/udev
  70 get_udevdir() {
  71         debug-print-function ${FUNCNAME} "${@}"
  72
  73         echo "$(_udev_get_udevdir)"
  74 }
  75
  76 # @FUNCTION: udev_dorules
  77 # @USAGE: rules [...]
  78 # @DESCRIPTION:
  79 # Install udev rule(s). Uses doins, thus it is fatal in EAPI 4
  80 # and non-fatal in earlier EAPIs.
  81 udev_dorules() {
  82         debug-print-function ${FUNCNAME} "${@}"
  83
  84         (
  85                 insopts -m 0644
  86                 insinto "$(_udev_get_udevdir)"/rules.d
  87                 doins "${@}"
  88         )
  89 }
  90
  91 # @FUNCTION: udev_newrules
  92 # @USAGE: oldname newname
  93 # @DESCRIPTION:
  94 # Install udev rule with a new name. Uses newins, thus it is fatal
  95 # in EAPI 4 and non-fatal in earlier EAPIs.
  96 udev_newrules() {
  97         debug-print-function ${FUNCNAME} "${@}"
  98
  99         (
 100                 insopts -m 0644
 101                 insinto "$(_udev_get_udevdir)"/rules.d
 102                 newins "${@}"
 103         )
 104 }
 105
 106 # @FUNCTION: udev_reload
 107 # @DESCRIPTION:
 108 # Run udevadm control --reload to refresh rules and databases
 109 udev_reload() {
 110         if [[ ${ROOT} != "" ]] && [[ ${ROOT} != "/" ]]; then
 111                 return 0
 112         fi
 113
 114         if [[ -d ${ROOT}/run/udev ]]; then
 115                 ebegin "Running udev control --reload for reloading rules and databases"
 116                 udevadm control --reload
 117                 eend $?
 118         fi
 119 }
 120
 121 fi