docs(meta): Point to arch-zbm in headline

fix(hook): AbortOnFail only works for PreTransaction hooks
docs(meta): It's root-on-ZFS
2023-10-27 02:37:36 +02:00 · 2023-10-27 02:31:32 +02:00 · 2023-10-27 01:20:09 +02:00 · 2023-10-27 00:50:53 +02:00 · 2023-10-27 00:50:26 +02:00
2 changed files with 5 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
 # zbm-syslinux-pacman-hook

-Arch Linux pacman hook to automatically recreate syslinux and MBR after updates
+Arch Linux pacman hook to automatically recreate syslinux and MBR after updates. This hook is intended to work with [quico.space/quico-os-setup/arch-zbm](https://quico.space/quico-os-setup/arch-zbm), a root-on-ZFS installation script that uses ZFSBootMenu as its boot loader.

 # Setup

+> Not explicitly listed here as a step but still relevant: This `pacman` hook only makes sense if you're using Syslinux as your boot loader and have the homonymous `syslinux` package installed.
+
 Get started like so:

 1. Install dependencies `jq` and `rsync`
@@ -39,7 +41,7 @@ If this returns zero or more than one mounted drive we bail, print an error mess

 # Assumptions

-This hook is intended to work with [quico.space/quico-os-setup/arch-zbm](https://quico.space/quico-os-setup/arch-zbm), a root on ZFS installation script that uses ZFSBootMenu as its boot loader; it's specifically intended for use on `arch-zbm` machines that use legacy BIOS. Before using this hook for any other purpose please closely review what it does and adapt to your use case as needed.
+Per [headline](#zbm-syslinux-pacman-hook) this hook is intended to work with [quico.space/quico-os-setup/arch-zbm](https://quico.space/quico-os-setup/arch-zbm); it's specifically intended for use on `arch-zbm` machines that use legacy BIOS. Before using this hook for any other purpose please closely review what it does and adapt to your use case as needed.

 We do not care about `pacman` events other than a `syslinux` package update. Specifically if ZFSBootMenu gets an update `syslinux` and our Master Boot Record remain unaffected. Kernel update? Same, no change needed since no kernel or module change directly influence the simple and decoupled structure of `syslinux`.

@@ -62,6 +64,6 @@ Commit _types_ besides `fix` and `feat` are:

 The following _scopes_ are known for this project. A Conventional Commits commit message may optionally use one of the following scopes or none:

- `script`: Any other script work that doesn't specifically fall into the above scopes
+- `script`: Work related to the commands triggered by `pacman`
 - `hook`: Configuring the hook(s)
 - `meta`: Affects the project's repo layout, readme content, file names etc.
--- a/pacman-zbm-syslinux-regen.hook
+++ b/pacman-zbm-syslinux-regen.hook
@@ -10,4 +10,3 @@ Exec = /usr/local/bin/pacman-zbm-syslinux-regen
 Depends = jq
 Depends = rsync
 Depends = syslinux
-AbortOnFail
Author	SHA1	Message	Date
hygienic-books	20490c4129	docs(meta): Point to arch-zbm in headline	2023-10-27 02:37:36 +02:00
hygienic-books	b39d7c436a	fix(hook): AbortOnFail only works for PreTransaction hooks	2023-10-27 02:31:32 +02:00
hygienic-books	262c0a6b5a	docs(meta): It's root-on-ZFS	2023-10-27 01:20:09 +02:00
hygienic-books	477dbfbb90	docs(meta): Explain Conventional Commits scopes	2023-10-27 00:50:53 +02:00
hygienic-books	d4c357f334	docs(meta): syslinux is a dependency, without it this hook is useless	2023-10-27 00:50:26 +02:00