Merge pull request #67 from random-archer/dev-code-review

code review

Author: Andrei-Pozolotin

README.md

@@ -26,6 +26,7 @@ Features provided by the included service units:
 * early network setup
 * interactive user shell
 * remote ssh access in initrd
+* cryptsetup + plymouth support
 * cryptsetup + custom password agent
 
 </details>
@@ -39,7 +40,6 @@ Useful issues [resolved in the past](https://github.com/random-archer/mkinitcpio
 Basic usage steps:
 
 1) study and practice [system recovery](https://github.com/random-archer/mkinitcpio-systemd-tool/wiki/System-Recovery)<br/>
-as practice shows configuration errors do occur
 
 2) install the package
 ```
@@ -48,7 +48,7 @@ pacman -S mkinitcpio-systemd-tool
 
 3) activate required hooks in `/etc/mkinitcpio.conf`:
 ```
-HOOKS="base ... systemd systemd-tool"
+HOOKS=(base ... systemd systemd-tool)
 ```
 
 4) configure, override and enable/disable [provided units](https://github.com/random-archer/mkinitcpio-systemd-tool/tree/master/src), for example: <br/>

src/crypttab

@@ -1,5 +1,9 @@
 # This file is part of https://github.com/random-archer/mkinitcpio-systemd-tool
 
+# REQUIRED READING:
+# * https://github.com/random-archer/mkinitcpio-systemd-tool/wiki/Root-vs-Fstab
+# * https://github.com/random-archer/mkinitcpio-systemd-tool/wiki/System-Recovery
+
 # crypttab: mappings for encrypted partitions in initramfs
 # * file location in initramfs: /etc/crypttab
 # * file location in real-root: /etc/mkinitcpio-systemd-tool/config/crypttab
@@ -11,12 +15,12 @@
 # https://www.freedesktop.org/software/systemd/man/systemd-cryptsetup-generator.html
 # https://github.com/systemd/systemd/blob/master/src/cryptsetup/cryptsetup-generator.c
 
-# note: 
+# note:
 # * provide here mapper partition UUID (instead of kernel command line)
 # * use password/keyfile=none to force cryptsetup password agent prompt
 # * ensure that mapper-path in fstab corresponds to mapper-name in crypttab
 # * for x-mount options see: https://www.freedesktop.org/software/systemd/man/systemd.mount.html
 
 # <mapper-name>   <block-device>       <password/keyfile>   <crypto-options>
 #  root           UUID={{UUID_ROOT}}       none                luks
-#  swap           UUID={{UUID_SWAP}}       none                luks 
+#  swap           UUID={{UUID_SWAP}}       none                luks

src/fstab

@@ -1,5 +1,9 @@
 # This file is part of https://github.com/random-archer/mkinitcpio-systemd-tool
 
+# REQUIRED READING:
+# * https://github.com/random-archer/mkinitcpio-systemd-tool/wiki/Root-vs-Fstab
+# * https://github.com/random-archer/mkinitcpio-systemd-tool/wiki/System-Recovery
+
 # fstab: mappings for direct partitions in initramfs:
 # * file location in initramfs: /etc/fstab
 # * file location in real-root: /etc/mkinitcpio-systemd-tool/config/fstab
@@ -11,8 +15,7 @@
 # https://www.freedesktop.org/software/systemd/man/systemd-fstab-generator.html
 # https://github.com/systemd/systemd/blob/master/src/fstab-generator/fstab-generator.c
 
-# note: 
-# * ensure /sysroot mount folder inside initramfs disk image
+# note:
 # * remove "root=/dev/mapper/root" stanza from kernel command line
 # * provide here root partition mapping (instead of kernel command line)
 # * ensure that mapper-path in fstab corresponds to mapper-name in crypttab

src/initrd-cryptsetup.service

@@ -50,7 +50,7 @@ TTYPath=/dev/console
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-console.path      replace=yes create=yes
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-console.service   replace=yes create=yes
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.path         replace=yes create=yes
-InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.servive      replace=yes create=yes
+InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.service      replace=yes create=yes
 
 # provide folder for sysroot.mount
 InitrdPath=/sysroot/    create=yes

src/initrd-plymouth.service

@@ -5,7 +5,7 @@
 # https://github.com/freedesktop/plymouth/blob/master/docs/development.txt
 
 # note:
-# this is a twin unit for initrd-plymouth.service
+# this is a twin unit for initrd-plymouth.path
 # enable only initrd-plymouth.path, initrd-plymouth.service is activated on demand
 
 # note:
@@ -50,7 +50,7 @@ TTYPath=/dev/console
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-plymouth.path      replace=yes create=yes
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-plymouth.service   replace=yes create=yes
 
-# plymouth client app
+# provision plymouth client
 InitrdBinary=/usr/bin/plymouth
 
 # TODO

src/mkinitcpio-hook.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/ash
+#!/usr/bin/env bash
 
 # This file is part of https://github.com/random-archer/mkinitcpio-systemd-tool
 

src/mkinitcpio-install.sh

@@ -1,10 +1,11 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # This file is part of https://github.com/random-archer/mkinitcpio-systemd-tool
 
 # Provides https://wiki.archlinux.org/index.php/Mkinitcpio#Build_hooks
 
 # Using shell linter: https://github.com/koalaman/shellcheck
+# shellcheck shell=bash
 
 # mkinitcpio entry point
 help() {
@@ -16,7 +17,7 @@ help() {
 # mkinitcpio entry point
 build() {
     #
-    # selection logic:
+    # systemd service unit selection logic:
     #
     # 1. "proper" symlinks in /etc/systemd/system
     # mostly represent aliased/enabled service units;

tool/image/test/cryptsetup/test_base/usr/lib/systemd/system/initrd-cryptsetup.service

@@ -51,7 +51,7 @@ TTYPath=/dev/console
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-console.path      replace=yes create=yes
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-console.service   replace=yes create=yes
 InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.path         replace=yes create=yes
-InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.servive      replace=yes create=yes
+InitrdPath=/usr/lib/systemd/system/systemd-ask-password-wall.service      replace=yes create=yes
 
 # provide folder for sysroot.mount
 InitrdPath=/sysroot/    create=yes