From 01e0d1d94118738db00e55995d471595b6f4ca76 Mon Sep 17 00:00:00 2001 From: Slack Coder Date: Wed, 1 May 2024 12:12:04 -0500 Subject: README: Add testing section and help new users Help users determine if the system is running to their expectations and help new linux users by being clearer about how efi-sync is integrated into the system. --- README.md | 34 ++++++++++++++++++++++++++++++++-- 1 file changed, 32 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ff6f40..ba6b28f 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,17 @@ Usage: ./efi-sync {install|watch} ``` -`efi-sync` watches your kernel path for updates. Once one is detected and the -package commands have completed, your EFI will be updated. +`efi-sync watch` watches your kernel path for updates. Your EFI will be updated once +one is detected and the package commands have completed. + +For systems using an initial ram disk (initrd), `efi-sync watch` watches +/lib/modules and /lib/firmware for updates. Your system is assumed to use one +if '/etc/mkinitrd.conf' is present on start. Once changes are detected, the +initrd file is recreated using 'mkinitrd' and with the result installed into +the EFI. + +You will need to manually install the initrd if it was recreated outside of +this program. ## Installation @@ -22,6 +31,8 @@ chown root:root /usr/local/sbin/efi-sync chmod +x /usr/local/sbin/efi-sync ``` +The efi-sync will need to be integrated to start automatically on your system. + ## Configuration The command looks for configuration at /etc/efi-sync.conf. @@ -40,3 +51,22 @@ EFI_INITRD=/boot/efi/Slackware/initrd.gz If you want the initial ram disk updated, ensure /etc/mkinitrd.conf exists and is configured correctly. + +### Testing + +To test everything is working correctly: + +``` +slackpkg -batch=on -default_answer=y upgrade --reinstall kernel-huge + +# You should confirm the recent update with this output. +date -r /boot/efi/EFI/Slackware/vmlinuz +``` + +For initrd updates: +``` +slackpkg -batch=on -default_answer=y upgrade --reinstall kernel-firmware + +# You should confirm the recent update with this output. +date -r /boot/efi/EFI/Slackware/initrd.gz +``` -- cgit v1.2.3