Makefile: Make sure make is invoked with appropriate permissions (#146 )

41_snapshots: update header
* 41_snapshots: update header * Update "Automatically update Grub" section. * Update "Purpose" section. * Update "What this script does" section
2026-03-04 21:15:02 +08:00 · 2021-03-01 13:35:44 +01:00 · 2021-02-21 15:37:43 +01:00 · 2021-02-21 05:26:39 +01:00 · 2021-01-23 20:46:14 +01:00 · 2021-01-23 12:02:11 +01:00
6 changed files with 132 additions and 43 deletions
--- a/33
+++ b/33
@@ -7,16 +7,16 @@
 #
 # Purpose:
 #   Improves Grub by adding "btrfs snapshots" to the Grub menu.
-#   You can start your system on a "snapshot" from the Grub menu.
-#   Supports manual snapshots, snapper ...
-#   Warning : booting on read-only snapshots can be tricky
+#   You can boot your system on a "snapshot" from the Grub menu.
+#   Supports manual snapshots, snapper, timeshift ...
+#   Warning : booting on read-only snapshots can be tricky.
 #   (Read about it, https://github.com/Antynea/grub-btrfs#warning-booting-on-read-only-snapshots-can-be-tricky)
 #
 # What this script does:
 # - Automatically List snapshots existing on root partition (btrfs).
 # - Automatically Detect if "/boot" is in separate partition.
-# - Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.
-# - Automatically Create corresponding "menuentry" in grub.cfg
+# - Automatically Detect kernel, initramfs and intel/amd microcode in "/boot" directory on snapshots.
+# - Automatically Create corresponding "menuentry" in grub.cfg.
 # - Automatically detect snapper and use snapper's snapshot description if available.
 # - Automatically generate grub.cfg if you use the provided systemd service.
 #
@@ -24,15 +24,11 @@
 # - Run `make install` or look into Makefile for instructions on where to put each file.
 #
 # Customization:
-#  Refer to config for the list of available options and their default values.
-#  Place your configurations to /etc/default/grub-btrfs/config.
+#  You have the possibility to modify many parameters in /etc/default/grub-btrfs/config.
 #
 # Automatically update Grub
-#  If you would like Grub to automatically update when a snapshots is made or deleted:
-#  - Use systemctl start/enable grub-btrfs.path
-#  - grub-btrfs.path automatically (re)generates grub.cfg when a modification appears in /.snapshots folder (by default).
-#  - If your snapshots aren't mounted in /.snapshots, you must modify the watch folder using systemctl edit grub-btrfs.path
-#  - See https://github.com/Antynea/grub-btrfs#automatically-update-grub
+#  If you would like grub-btrfs menu to automatically update when a snapshot is created or deleted:
+#  - Refer to https://github.com/Antynea/grub-btrfs#automatically-update-grub.
 #
 # Special thanks for assistance and contributions:
 # - My friends
@@ -115,6 +111,13 @@ else
    LINUX_ROOT_DEVICE=UUID=${root_uuid}
 fi
 }
+## Detect rootflags
+detect_rootflags()
+{
+    local fstabflags=$(grep -oE '^\s*[^#][[:graph:]]+\s+/\s+btrfs\s+[[:graph:]]+' "${gbgmp}/${snap_dir_name}/etc/fstab" \
+                        | sed -E 's/^.*[[:space:]]([[:graph:]]+)$/\1/;s/,?subvol(id)?=[^,$]+//g;s/^,//')
+    rootflags="rootflags=${fstabflags:+$fstabflags,}${GRUB_BTRFS_ROOTFLAGS:+$GRUB_BTRFS_ROOTFLAGS,}"
+}

 ### Error Handling
 print_error()
@@ -183,7 +186,7 @@ make_menu_entries()
        fi
        echo 'Loading Snapshot: "${snap_date_time}" "${snap_dir_name}"'
        echo 'Loading Kernel: "${k}" ...'
-        linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" rw ${kernel_parameters} rootflags=subvol=\""${snap_dir_name}"\""
+        linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" ${kernel_parameters} ${rootflags}subvol=\""${snap_dir_name}"\""
                if [[ "${name_microcode}" != "x" ]] ; then
                    entry "\
        echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
@@ -417,6 +420,8 @@ boot_bounded()
        detect_kernel
        if [ -z "${list_kernel}" ]; then continue; fi
        name_kernel=("${list_kernel[@]##*"/"}")
+        # Detect rootflags
+        detect_rootflags
        # Initramfs (Original + custom initramfs)
        detect_initramfs
        if [ -z "${list_initramfs}" ]; then continue; fi
@@ -472,6 +477,8 @@ boot_separate()
        snap_dir_name="$(trim "$snap_dir_name")"
        snap_date_time="$(echo "$item" | cut -d' ' -f1-2)"
        snap_date_time="$(trim "$snap_date_time")"
+        # Detect rootflags
+        detect_rootflags
        # show snapshot found during run "grub-mkconfig"
        if [[ "${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}" = "true" ]]; then
            printf "Found snapshot: %s\n" "$item" >&2 ;
--- a/68
+++ b/68
@@ -1,31 +1,71 @@
 PKGNAME ?= grub-btrfs
 PREFIX ?= /usr

+INITCPIO ?= false
+
 SHARE_DIR = $(DESTDIR)$(PREFIX)/share
 LIB_DIR = $(DESTDIR)$(PREFIX)/lib

-.PHONY: install
+.PHONY: install uninstall help

 install:
+	@if test "$(shell id -u)" != 0; then \
+		echo "You are not root, run this target as root please."; \
+		exit 1; \
+	fi
 	@install -Dm755 -t "$(DESTDIR)/etc/grub.d/" 41_snapshots-btrfs
 	@install -Dm644 -t "$(DESTDIR)/etc/default/grub-btrfs/" config
 	@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.service
 	@install -Dm644 -t "$(LIB_DIR)/systemd/system/" grub-btrfs.path
 	@install -Dm644 -t "$(SHARE_DIR)/licenses/$(PKGNAME)/" LICENSE
-	@install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-install" "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"	# Arch Linux only
-	@install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-install" "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"	# Arch Linux only
+	@# Arch Linux like distros only :
+	@if test "$(INITCPIO)" = true; then \
+		install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-install" "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"; \
+		install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-hook" "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs"; \
+	 fi
 	@install -Dm644 -t "$(SHARE_DIR)/doc/$(PKGNAME)/" README.md
 	@install -Dm644 "initramfs/readme.md" "$(SHARE_DIR)/doc/$(PKGNAME)/initramfs-overlayfs.md"

 uninstall:
-	rm -f "$(DESTDIR)/etc/grub.d/41_snapshots-btrfs"
-	rm -f "$(DESTDIR)/etc/default/grub-btrfs/config"
-	rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.service"
-	rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.path"
-	rm -f "$(SHARE_DIR)/licenses/$(PKGNAME)/LICENSE"
-	rm -f "$(DESTDIR)/boot/grub/grub-btrfs.cfg"
-	rm -f "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs" # Arch Linux only
-	rm -f "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs" # Arch Linux only
-	rm -rf "$(SHARE_DIR)/doc/$(PKGNAME)/" README.md
-	rm -rf "$(SHARE_DIR)/doc/$(PKGNAME)/initramfs-overlayfs.md"
-	rmdir --ignore-fail-on-non-empty "$(DESTDIR)/etc/default/grub-btrfs"
+	@if test "$(shell id -u)" != 0; then \
+		echo "You are not root, run this target as root please."; \
+		exit 1; \
+	fi
+	@grub_dirname="$$(grep -oP '^[[:space:]]*GRUB_BTRFS_GRUB_DIRNAME=\K.*' "$(DESTDIR)/etc/default/grub-btrfs/config" | sed "s|\s*#.*||;s|(\s*\(.\+\)\s*)|\1|;s|['\"]||g")"; \
+	 rm -f "$${grub_dirname:-/boot/grub}/grub-btrfs.cfg"
+	@rm -f "$(DESTDIR)/etc/default/grub-btrfs/config"
+	@rm -f "$(DESTDIR)/etc/grub.d/41_snapshots-btrfs"
+	@rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.service"
+	@rm -f "$(LIB_DIR)/systemd/system/grub-btrfs.path"
+	@rm -f "$(LIB_DIR)/initcpio/install/grub-btrfs-overlayfs"
+	@rm -f "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs"
+	@# Arch Linux UNlike distros only :
+	@if test "$(INITCPIO)" != true && test -d "$(LIB_DIR)/initcpio"; then \
+		rmdir --ignore-fail-on-non-empty "$(LIB_DIR)/initcpio/install" || :; \
+		rmdir --ignore-fail-on-non-empty "$(LIB_DIR)/initcpio/hooks" || :; \
+		rmdir --ignore-fail-on-non-empty "$(LIB_DIR)/initcpio" || :; \
+	 fi
+	@rm -f "$(SHARE_DIR)/doc/$(PKGNAME)/README.md"
+	@rm -f "$(SHARE_DIR)/doc/$(PKGNAME)/initramfs-overlayfs.md"
+	@rm -f "$(SHARE_DIR)/licenses/$(PKGNAME)/LICENSE"
+	@rmdir --ignore-fail-on-non-empty "$(SHARE_DIR)/doc/$(PKGNAME)/" || :
+	@rmdir --ignore-fail-on-non-empty "$(SHARE_DIR)/licenses/$(PKGNAME)/" || :
+	@rmdir --ignore-fail-on-non-empty "$(DESTDIR)/etc/default/grub-btrfs" || :
+
+help:
+	@echo
+	@echo "Usage: $(MAKE) [ <parameter>=<value> ... ] [ <action> ]"
+	@echo
+	@echo "  actions: install"
+	@echo "           uninstall"
+	@echo "           help"
+	@echo
+	@echo "  parameter | type | description                    | defaults"
+	@echo "  ----------+------+--------------------------------+----------------------------"
+	@echo "  DESTDIR   | path | install destination            | <unset>"
+	@echo "  PREFIX    | path | system tree prefix             | '/usr'"
+	@echo "  SHARE_DIR | path | shared data location           | '\$$(DESTDIR)\$$(PREFIX)/share'"
+	@echo "  LIB_DIR   | path | system libraries location      | '\$$(DESTDIR)\$$(PREFIX)/lib'"
+	@echo "  PKGNAME   | name | name of the ditributed package | 'grub-btrfs'"
+	@echo "  INITCPIO  | bool | include mkinitcpio hook        | false"
+	@echo
--- a/README.md
+++ b/README.md
@@ -6,10 +6,10 @@
 This is a version 4.xx of grub-btrfs
 ##### BTC donation address: `1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt`
 ##
-### Description
+### Description :
 Improves Grub by adding "btrfs snapshots" to the Grub menu.

-You can start your system on a "snapshot" from the Grub menu.  
+You can boot your system on a "snapshot" from the Grub menu.  
 Supports manual snapshots, snapper, timeshift ...

 ##### Warning: booting on read-only snapshots can be tricky
@@ -46,28 +46,55 @@ NOTE: Generate your Grub menu after installation for the changes to take effect.
 On Arch Linux use `grub-mkconfig -o /boot/grub/grub.cfg`.

 ##
-### Customization:
+### Customization :

 You have the possibility to modify many parameters in `/etc/default/grub-btrfs/config`.  
 See [config file](https://github.com/Antynea/grub-btrfs/blob/master/config) for more information.

 ##
 ### Automatically update grub
-If you would like Grub to automatically update when a snapshot is made or deleted:
-* Use `systemctl start/enable grub-btrfs.path`.
-* `grub-btrfs.path` automatically (re)generates `grub.cfg` when a modification appears in `/.snapshots` folder (by default).
-* If your snapshots aren't mounted in `/.snapshots`, you must modify the watch folder using `systemctl edit grub-btrfs.path`.  
-	* For example: Timeshift mount its snapshots in `/run/timeshift/backup/timeshift-btrfs/snapshots` folder.
+1- If you would like grub-btrfs menu to automatically update when a snapshot is created or deleted:
+* Use `systemctl enable grub-btrfs.path`.
+  * `grub-btrfs.path` automatically (re)generates `grub-btrfs.cfg` when a modification appears in `/.snapshots` mount point (by default).
+  * If the `/.snapshots` mount point is already mounted, then use `systemctl start grub-btrfs.path` to start monitoring.  
+    Otherwise, the unit will automatically start monitoring when the mount point will be available.
+* If your snapshots location aren't mounted in `/.snapshots`, you must modify `grub-btrfs.path` unit using  
+`systemctl edit --full grub-btrfs.path` and run `systemctl reenable grub-btrfs.path` for changes take effect.  
+To find out the name of the `.mount` unit  
+use `systemctl list-units -t mount`.  
+	* For example: Timeshift mounts its snapshot folder in `/run/timeshift/backup/timeshift-btrfs/snapshots`.

-		Use `systemctl edit grub-btrfs.path`.
-		Then wrote:
+		Use `systemctl edit --full grub-btrfs.path`.
+		Then replace the whole block by:
 		```
+		[Unit]
+		Description=Monitors for new snapshots
+		DefaultDependencies=no
+		Requires=run-timeshift-backup.mount
+		After=run-timeshift-backup.mount
+		BindsTo=run-timeshift-backup.mount
+
 		[Path]
 		PathModified=/run/timeshift/backup/timeshift-btrfs/snapshots
+
+		[Install]
+		WantedBy=run-timeshift-backup.mount
 		```
-		and finally save.
+		Then save and finally run `systemctl reenable grub-btrfs.path` for changes take effect.  
+		Optional:  
+		If the `/run/timeshift/backup/timeshift-btrfs/snapshots` mount point is already mounted,  
+		then use `systemctl start grub-btrfs.path` to start monitoring.  
+		Otherwise, the unit will automatically start monitoring when the mount point will be available.  
 	* You can view your change to `systemctl cat grub-btrfs.path`.
 	* To revert change use `systemctl revert grub-btrfs.path`.
+
+2- If you would like grub-btrfs menu to automatically update on system restart/shutdown:  
+[Look at this comment](https://github.com/Antynea/grub-btrfs/issues/138#issuecomment-766918328)  
+Currently not implemented  
+##### Warning :
+by default, `grub-mkconfig` command is used.  
+Might be `grub2-mkconfig` on some systems (Fedora ...).   
+Edit `GRUB_BTRFS_MKCONFIG` variable in `/etc/default/grub-btrfs/config` file to reflect this.
 ##
 ### Special thanks for assistance and contributions
 * [maximbaz](https://github.com/maximbaz)
--- a/17
+++ b/17
@@ -54,6 +54,14 @@
 # Default: ("")
 #GRUB_BTRFS_CUSTOM_MICROCODE=("custom-ucode.img" "custom-uc.img "custom_ucode.cpio")

+# Comma seperated mount options to be used when booting a snapshot.
+# They can be defined here as well as in the "/" line inside the respective snapshots'
+# "/etc/fstab" files.  Mount options found in both places are combined, and this variable
+# takes priority over `fstab` entries.
+# NB: Do NOT include "subvol=..." or "subvolid=..." here.
+# Default: ""
+#GRUB_BTRFS_ROOTFLAGS="space_cache,commit=10,norecovery"
+
 # Ignore specific path during run "grub-mkconfig".
 # Only exact paths are ignored.
 # e.g : if `specific path` = @, only `@` snapshot will be ignored.
@@ -85,10 +93,13 @@ GRUB_BTRFS_IGNORE_PREFIX_PATH=("var/lib/docker" "@var/lib/docker" "@/var/lib/doc
 # Default: "/boot"
 #GRUB_BTRFS_BOOT_DIRNAME="/boot"

-# Name/path of grub-mkconfig, use by "grub-btrfs.service"
-# Might be 'grub2-mkconfig' on some systems
+# Name/path of grub-mkconfig command, use by "grub-btrfs.service"
+# Might be 'grub2-mkconfig' on some systems (Fedora ...)
+# Default paths are /sbin:/bin:/usr/sbin:/usr/bin,
+# if your path is missing, report it on the upstream project.
 # For example, on Fedora : "/sbin/grub2-mkconfig"
-# Default: /usr/bin/grub-mkconfig
+# You can use only name or full path.
+# Default: grub-mkconfig
 #GRUB_BTRFS_MKCONFIG=/usr/bin/grub2-mkconfig

 # Snapper
--- a/grub-btrfs.path
+++ b/grub-btrfs.path
@@ -1,8 +1,12 @@
 [Unit]
 Description=Monitors for new snapshots
+DefaultDependencies=no
+Requires=\x2esnapshots.mount
+After=\x2esnapshots.mount
+BindsTo=\x2esnapshots.mount

 [Path]
 PathModified=/.snapshots

 [Install]
-WantedBy=multi-user.target
+WantedBy=\x2esnapshots.mount
--- a/grub-btrfs.service
+++ b/grub-btrfs.service
@@ -8,4 +8,4 @@ Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
 # Load environment variables from the configuration
 EnvironmentFile=/etc/default/grub-btrfs/config
 # Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists and is not empty, else regenerate the whole grub menu
-ExecStart=/bin/bash -c 'if [ -s "${GRUB_BTRFS_DIRNAME:-/boot/grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o ${GRUB_BTRFS_DIRNAME:-/boot/grub}/grub.cfg; fi' 
+ExecStart=bash -c 'if [ -s "${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-grub-mkconfig} -o ${GRUB_BTRFS_GRUB_DIRNAME:-/boot/grub}/grub.cfg; fi'
Author	SHA1	Message	Date
Björn Daase	3433754c69	Makefile: Make sure make is invoked with appropriate permissions (#146 )	2021-03-01 13:35:44 +01:00
Antynea	db753a9ac8	41_snapshots: update header * 41_snapshots: update header * Update "Automatically update Grub" section. * Update "Purpose" section. * Update "What this script does" section	2021-02-21 15:37:43 +01:00
Antynea	83bf1da01e	Improves systemd.path unit (#139 ) * grub-btrfs.path : improves unit #### Remember to modify your configuration accordingly. Allows the unit to start and stop automatically when the mount point is detected. If the mount point is already mounted when the unit is activated `systemctl enable grub-btrfs.path`, it will be necessary to start the unit for monitoring to begin `systemctl start grub-btrfs.path`. - `DefaultDependencies=no` Prevents systemd from automatically generating `Wants= or Requires= or After=`. - `Requires=\x2esnapshots.mount` Ensures unit is started if mount point exists. - `After=\x2esnapshots.mount` Unit start after the mounting point exists. - `BindsTo=\x2esnapshots.mount` If the mount point is removed, the unit will stop. - `PathModified=\x2esnapshots.mount` The monitored folder containing the snapshots. - `WantedBy=\x2esnapshots.mount` If the mount point exists, unit start automatically. (only if unit is activated before the mount point is mounted) * Readme: Update "Automatically update grub" section Update section following the recent change in the `grub-btrfs.path` unit. Add information to be able to update the `grub-btrfs` menu every time the system is restart/shutdown.	2021-02-21 05:26:39 +01:00
Kriss	2f22fd8630	[make help] mention `INITCPIO` switch (#137 ) This commit is an expansion to : `87b816345b` Since a new `make` parameter has been introduced, it should be mentioned in the output of the `help` target. Also, the table is being expanded by a new column describing the type of data that each parameter may be assigned, like paths or boolean values.	2021-01-23 20:46:14 +01:00
Antynea	88a0320d62	[Makefile] remove `mkinitcpio` dependency (#136 ) Errata commit: This commit has no substantive code change. This commit is provided only to document a correction to a previous commit message. This pertains to commit object `87b816345b` Due to improper handling, the aforementioned commit message is incorrect. Correct message is : [Makefile] remove `mkinitcpio` dependency The mkinitcpio binary is not available even on Arch, when building in a clean environment (e.g. building distro packages in a clean chroot). This causes the mkinitcpio hook to not be present in the final package, which is resolved by this commit, by adding a `make` switch. This switch allows users to explicitely turn on inclusion of the hook. [uninstall:] don't remove non-existent folders This prevents some warnings being output when on a non-Archlinux system, without a previously installed initcpio hook, a `make uninstall` is per- formed. These three folders should _only_ be deleted if they had been mistakenly created during `make install`. Co-authored-by: Kriss <kr1ss.x@yandex.com>	2021-01-23 12:02:11 +01:00
Kriss	87b816345b	[Makefile] remove `mkinitcpio` dependency (#136 ) [Makefile] remove `mkinitcpio` dependency	2021-01-17 22:25:10 +01:00
Kriss	d68fdf5fff	Adds a new config variable "GRUB_BTRFS_ROOTFLAGS" (#133 ) Script: Improves the rootflags option in the kernel command line: - Remove "rw" flag. - Parse fstab mountoptions and add them to rootflags: Adds functionality to read in snapshot specific mount flags from the respective fstab and uses them in combination with the new config option, while the latter is prioritized. Both places can, but don't need to define mount flags. If either of them doesn't, it will simply not be taken into account. Config file: Adds a new config variable "GRUB_BTRFS_ROOTFLAGS": - The new variable is used to include user-defined rootflags in the kernel command line of generated snapshot bootmenu entries. See config file for more infos.	2021-01-11 13:37:40 +01:00
Kriss	87168d2d50	[Makefile] Modifies install/uninstall target. Adds help target (#135 ) Makefile: Install target: - Added "uninstall" and "help" target to ".phony". - Hook initcpio will be installed only on Arch Linux like distributions. Uninstall target: - All commands are in silent mode. - "rmdir" command will not interrupt the uninstallation if the folder does not exist. - Remove "-r" option to "rm" command. - Fix a mistake in deleting the "readme" file. - Uninstalling the "grub-btrfs.cfg" file uses the "GRUB_BTRFS_GRUB_DIRNAME" variable. - Delete initcpio folder if not on Arch. - Delete "grub-btrfs" docs and licenses folders. help target: - Add "help" target.	2021-01-11 13:04:09 +01:00
Antynea	a437b80a35	improves systemd service (#131 ) grub-btrfs.service: remove unnecessary path for bash and grub-mkconfig command readme.md: add warning section to systemd service section config file: Improves the description of the variable GRUB_BTRFS_MKCONFIG	2021-01-03 14:50:34 +01:00
Antynea	9408231ecc	Corrects an erroneous variable (#128 ) Fix #127 Replaces "GRUB_BTRFS_DIRNAME" variable to match with new variable "GRUB_BTRFS_GRUB_DIRNAME" in config file.	2020-12-30 15:31:28 +01:00
Antynea	9722f6732c	Corrects a mistake Corrects the duplicate that appeared Line16 should be : `@install -Dm644 "initramfs/Arch Linux/overlay_snap_ro-hook" "$(LIB_DIR)/initcpio/hooks/grub-btrfs-overlayfs" # Arch Linux only`	2020-10-22 21:19:54 +02:00