From: Jóhann B. Guðmundsson <johannbg@gmail.com>
Date: Tue, 18 May 2021 10:34:46 +0000 (+0000)
Subject: fix(warpclock): minor cleanups
X-Git-Tag: 055~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7d205598c6a500b58b4d328e824d0446276f7ced;p=thirdparty%2Fdracut.git

fix(warpclock): minor cleanups

- Removing shell mode lines
- Remove uncessary file requirements
- Remove hard coded path to binary
- Add missing license header
- Document sections
- refactor install section
---

diff --git a/modules.d/00warpclock/module-setup.sh b/modules.d/00warpclock/module-setup.sh
index e6fc47119..44aa17790 100644
--- a/modules.d/00warpclock/module-setup.sh
+++ b/modules.d/00warpclock/module-setup.sh
@@ -1,29 +1,39 @@
 #!/bin/bash
-# -*- mode: shell-script; indent-tabs-mode: nil; sh-basic-offset: 4; -*-
-# ex: ts=8 sw=4 sts=4 et filetype=sh
+# This file is part of dracut.
+# SPDX-License-Identifier: GPL-2.0-or-later
 
-# called by dracut
+# Prerequisite check(s) for module.
 check() {
+
     # hwclock does not exist on S390(x), bail out silently then
     local _arch=${DRACUT_ARCH:-$(uname -m)}
     [ "$_arch" = "s390" -o "$_arch" = "s390x" ] && return 1
 
-    [ -e /etc/localtime -a -e /etc/adjtime ] || return 1
-    require_binaries /sbin/hwclock || return 1
+    # If the binary(s) requirements are not fulfilled the module can't be installed.
+    require_binaries hwclock || return 1
 
+    # Return 255 to only include the module, if another module requires it.
     return 255
+
 }
 
-# called by dracut
+# Module dependency requirements.
 depends() {
+
+    # Return 0 to include the dependent module(s) in the initramfs.
     return 0
+
 }
 
-# called by dracut
+# Install the required file(s) and directories for the module in the initramfs.
 install() {
-    inst /usr/share/zoneinfo/UTC
-    inst /etc/localtime
-    inst /etc/adjtime
+
     inst_hook pre-trigger 00 "$moddir/warpclock.sh"
-    inst /sbin/hwclock
+
+    inst_multiple -o \
+        /usr/share/zoneinfo/UTC \
+        /etc/localtime \
+        /etc/adjtime \
+        hwclock
+
 }
diff --git a/modules.d/00warpclock/warpclock.sh b/modules.d/00warpclock/warpclock.sh
index c97eb6013..fb4df0b8e 100644
--- a/modules.d/00warpclock/warpclock.sh
+++ b/modules.d/00warpclock/warpclock.sh
@@ -1,4 +1,9 @@
 #!/bin/sh
+# This file is part of dracut warpclock module.
+# SPDX-License-Identifier: GPL-2.0-or-later
+
+# Set the kernel's timezone and reset the system time
+# if adjtime is set to LOCAL.
 
 if test -e /etc/adjtime; then
     while read -r line; do