Support snapper 0.7.0 (#57 )

Snapper changed the order of columns, ID now comes before type.
Make 'grub-mkconfig' command name configurable (#56 )
2026-03-05 05:35:01 +08:00 · 2018-10-24 00:29:06 +02:00 · 2018-08-15 14:02:13 +02:00 · 2018-07-09 18:55:09 +02:00 · 2018-06-30 14:46:30 +02:00 · 2018-06-11 15:52:00 +02:00
6 changed files with 172 additions and 116 deletions
--- a/10-update_grub.conf
+++ b/10-update_grub.conf
@@ -1,2 +1,7 @@
 [Service]
-ExecStartPost=/usr/sbin/grub-mkconfig -o /boot/grub/grub.cfg
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/grub.d/41_snapshots-btrfs_config
+# Regenerate just '/boot/grub/grub-btrfs.cfg' if it exists, else regenerate the whole grub menu
+ExecStartPost=/bin/bash -c 'if [ -s "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg; fi'
--- a/202
+++ b/202
@@ -2,67 +2,39 @@
 #
 #
 #########################################################################################################################################################################
-# Written by: Antynea																																					#
-# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt																												#
-#																																										#
-# Purpose: Include btrfs snapshots at boot options (grub-menu).																											#
-#																																										#
-# What this script does:																																				#
-# Simple rollback using snapshots you made previously.																													#
-# - 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. (For custon name, see below.)											#
-# - Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.																	#
-# - Automatically detect snapper and use snapper's snapshot description if available.																					#
-#																																										#
-# How to use it:																																						#
-# - Add this lines to /etc/default/grub:																																#
-#																																										#
-# * GRUB_BTRFS_SUBMENUNAME="Arch Linux snapshots" 																														#
-#		(Name appearing in the Grub menu.)																																#
-# * GRUB_BTRFS_PREFIXENTRY="Snapshot:"        		   																													#
-#		(Add a name ahead your snapshots entries in the Grub menu.) 																									#
-# * GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"																																#
-#		(Show full path snapshot or only name in the Grub menu)																											#
-# * GRUB_BTRFS_TITLE_FORMAT="p/d/n"																																		#
-#		(Custom title, shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available)													#
-# * GRUB_BTRFS_LIMIT="50"																																				#
-#		(Limit the number of snapshots populated in the GRUB menu.)																										#
-# * GRUB_BTRFS_SUBVOLUME_SORT="descending"																																#
-#		(Sort the found subvolumes by newest first ("descending") or oldest first ("ascending").																		#
-#		If "ascending" is chosen then the $GRUB_BTRFS_LIMIT oldest subvolumes will populate the menu.)																	#
-# * GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"																																#
-#		(Show snapshots found during run "grub-mkconfig")																												#
-# * GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"																														#
-#		(Show Total of snapshots found during run "grub-mkconfig")																										#
-# * GRUB_BTRFS_NKERNEL=("vmlinuz-linux") 		 																														#
-#		(Use only if you have custom kernel name or auto-detect failed.)																								#
-# * GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")																								#
-#		(Use only if you have custom initramfs name or auto-detect failed.)																								#
-# * GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img") 																															#
-#		(Use only if you have custom intel-ucode or auto-detect failed.)		    																					#
-# * GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot")																										#
-#		(Ignore specific path during run "grub-mkconfig")																												#
-# * GRUB_BTRFS_SNAPPER_CONFIG="root"																																	#
-#		(Snapper's config name to use)																																	#
-# * GRUB_BTRFS_DISABLE="false"																																			#
-#		Disable Grub-btrfs (default=active)																																#
-#																																										#
-# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/grub/grub.cfg)																							#
-#																																										#
-# - grub-btrfs automatically generates snapshots entries.																												#
-# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)															#
-#																																										#
-# Automatically update grub																																				#
-#  If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install 10-update_grub.conf in the following locations:	#
-# - /etc/systemd/system/snapper-timeline.service.d/																														#
-# - /etc/systemd/system/snapper-cleanup.service.d/																														#
-# Once the configuration files are in place, systemctl daemon-reload should be run to reload the units and make the changes active.										#
-#																																										#
-# Special thanks for assistance and contributions:																														#
-# - My friends																																							#
-# - All contributors on Github																																			#
-#																																										#
+# Written by: Antynea
+# BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
+# Github: https://github.com/Antynea/grub-btrfs
+#
+# Purpose: Include btrfs snapshots at boot options (grub-menu).
+#
+# What this script does:
+# Simple rollback using snapshots you made previously.
+# - 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 , which ensures a very easy rollback.
+# - Automatically detect snapper and use snapper's snapshot description if available.
+#
+# How to customize it:
+# - Refer 41_snapshots-btrfs_config for the list of available options and their default values.
+# - Place your configurations to either /etc/grub.d/41_snapshots-btrfs_config or /etc/default/grub.
+#
+# - Generate grub.cfg (on Arch Linux use grub-mkconfig -o /boot/$grub_directory/grub.cfg)
+#
+# - grub-btrfs automatically generates snapshots entries.
+# - You will see it appear different entries (e.g : Snapshot: [2014-02-12 11:24:37] my snapshot name overkill)
+#
+# Automatically update grub
+#  If you would like grub to automatically update when Snapper timeline snapshots and cleanups occur, simply install 10-update_grub.conf in the following locations:
+# - /etc/systemd/system/snapper-timeline.service.d/
+# - /etc/systemd/system/snapper-cleanup.service.d/
+# Once the configuration files are in place, systemctl daemon-reload should be run to reload the units and make the changes active.
+#
+# Special thanks for assistance and contributions:
+# - My friends
+# - All contributors on Github
+#
 #########################################################################################################################################################################

 set -e
@@ -71,10 +43,11 @@ prefix="/usr"
 exec_prefix="/usr"
 datarootdir="/usr/share"
 sysconfdir="/etc"
+grub_btrfs_config="${sysconfdir}/grub.d/41_snapshots-btrfs_config"

 . "${sysconfdir}/default/grub"
-. "$pkgdatadir/grub-mkconfig_lib"
-# . "$datarootdir/grub/grub-mkconfig_lib" # Uncomment if you run "bash -x"
+[[ -f "$grub_btrfs_config" ]] && . "$grub_btrfs_config"
+. "$datarootdir/grub/grub-mkconfig_lib"

 ######################################
 ### Variables in /etc/default/grub ###
@@ -110,8 +83,12 @@ show_snap_found=${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}
 show_total_snap_found=${GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND:-"true"}
 ## Ignore specific path during run "grub-mkconfig"
 ignore_specific_path=("${GRUB_BTRFS_IGNORE_SPECIFIC_PATH[@]}")
-## snapper's config name
+## Snapper's config name
 snapper_config=${GRUB_BTRFS_SNAPPER_CONFIG:-"root"}
+## Override boot partition detection
+override_boot_partition_detection=${GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION:-"false"}
+## Customize GRUB directory
+grub_directory=${GRUB_BTRFS_DIRNAME:-"grub"}

 ########################
 ### variables script ###
@@ -119,14 +96,20 @@ snapper_config=${GRUB_BTRFS_SNAPPER_CONFIG:-"root"}
 ## Internationalization (default : english)
 export TEXTDOMAIN=grub-btrfs-git
 export TEXTDOMAINDIR="/usr/share/locale"
-## hints string
-hs_boot=$(${grub_probe} --target="hints_string" "/boot" 2>/dev/null)
-## UUID of the boot partition
-boot_uuid=$(${grub_probe} --target="fs_uuid" "/boot" 2>/dev/null)
-## Type filesystem of boot partition
+## Probe info "Boot partition"
+# Boot device
+boot_device=$(${grub_probe} --target=device "/boot")
+# hints string
+boot_hs=$(${grub_probe} --device "${boot_device}" --target="hints_string" 2>/dev/null)
+# UUID of the boot partition
+boot_uuid=$(${grub_probe} --device "${boot_device}" --target="fs_uuid" 2>/dev/null)
+# Type filesystem of boot partition
 boot_fs=$(${grub_probe} --target="fs" "/boot" 2>/dev/null)
-## UUID of the root partition
-root_uuid=$(${grub_probe} "/" --target="fs_uuid" 2>/dev/null)
+## Probe info "Root partition"
+# Root device
+root_device=$(${grub_probe} --target=device "/")
+# UUID of the root partition
+root_uuid=$(${grub_probe} --device "${root_device}" --target="fs_uuid" 2>/dev/null)
 ## Parameters passed to the kernel
 kernel_parameters="$GRUB_CMDLINE_LINUX $GRUB_CMDLINE_LINUX_DEFAULT"
 ## Mount point location
@@ -135,6 +118,16 @@ gbgmp=$(mktemp -d)
 CLASS="--class snapshots --class gnu-linux --class gnu --class os"
 ## save IFS
 oldIFS=$IFS
+## Detect uuid requirement (lvm,btrfs...)
+check_uuid_required() {
+if [ "x${root_uuid}" = "x" ] || [ "x${GRUB_DISABLE_LINUX_UUID}" = "xtrue" ] \
+    || ! test -e "/dev/disk/by-uuid/${root_uuid}" \
+    || ( test -e "${root_device}" && uses_abstraction "${root_device}" lvm ); then
+  LINUX_ROOT_DEVICE=${root_device}
+else
+  LINUX_ROOT_DEVICE=UUID=${root_uuid}
+fi
+}


 ######################
@@ -164,10 +157,10 @@ test_btrfs()

 ## Create entry
 entry()	{
-echo "$@" >> "/boot/grub/grub-btrfs.cfg"
+echo "$@" >> "/boot/$grub_directory/grub-btrfs.cfg"
 # local arg="$@"
-# echo "${arg}" >> "/boot/grub/grub-btrfs.cfg"
-# cat << EOF >> "/boot/grub/grub-btrfs.cfg"
+# echo "${arg}" >> "/boot/$grub_directory/grub-btrfs.cfg"
+# cat << EOF >> "/boot/$grub_directory/grub-btrfs.cfg"
 # ${arg}
 # EOF
 }
@@ -182,16 +175,17 @@ make_menu_entries()
 		[[ ! -f "${boot_dir}"/"${k}" ]] && continue;
 		kversion=${k#*"-"}
 		for i in "${name_initramfs[@]}"; do
-			prefix_i=${i[@]%%"-"*}
-			suffix_i=${i[@]##*"-"}
-			if 		[ -f "${boot_dir}"/"${prefix_i}-${kversion}-${suffix_i}" ];	then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}" ]; 			then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}.img" ]; 		then i="${i}";
-			elif 	[ -f "${boot_dir}"/"${prefix_i}-${kversion}.gz" ]; 			then i="${i}";
+			prefix_i=${i%%"-"*}
+			suffix_i=${i#*"-"}
+         	alt_suffix_i=${i##*"-"}
+            if   [ "${kversion}" = "${suffix_i}" ];                 then i="${i}";
+            elif [ "${kversion}.img" = "${suffix_i}" ];             then i="${i}";
+            elif [ "${kversion}-fallback.img" = "${suffix_i}" ];    then i="${i}";
+            elif [ "${kversion}.gz" = "${suffix_i}" ];              then i="${i}";
 			else 	continue ;
 			fi
 			for u in "${name_microcode[@]}"; do
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != initramfs-linux-fallback.img ]] ; then
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
 				entry "
 	menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid'{"
 				else
@@ -205,14 +199,14 @@ make_menu_entries()
 		set gfxpayload=keep
 		insmod ${boot_fs}
 		if [ x\$feature_platform_search_hint = xy ]; then
-			search --no-floppy --fs-uuid  --set=root ${hs_boot} ${boot_uuid}
+			search --no-floppy --fs-uuid  --set=root ${boot_hs} ${boot_uuid}
 		else
 			search --no-floppy --fs-uuid  --set=root ${boot_uuid}
 		fi
 		echo 'Loading Snapshot: "${snap_date_time}" "${snap_dir_name}"'
 		echo 'Loading Kernel: "${k}" ...'
-		linux \"${boot_dir_root_grub}/"${k}"\" root=UUID=${root_uuid} rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != initramfs-linux-fallback.img ]] ; then
+		linux \"${boot_dir_root_grub}/"${k}"\" root="${LINUX_ROOT_DEVICE}" rw rootflags=subvol=\""${snap_dir_name}"\" ${kernel_parameters}"
+				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
 					entry "\
 		echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
 		initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
@@ -243,8 +237,8 @@ snapshot_list()
 	# Query info from snapper if it is installed
 	type snapper >/dev/null 2>&1
 	if [[ $? -eq 0 ]]; then
-		local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))
-		local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
+		local snapper_ids=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 1))
+		local snapper_types=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 2))

 		IFS=$'\n'
 		local snapper_descriptions=($(snapper -t 0 -c "$snapper_config" list | tail -n +3 | cut -d'|' -f 7))
@@ -394,16 +388,15 @@ path_snapshot()
 title_format()
 {
 	case "${title_format}" in
-		p/d/n) 	title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}";;
 		p/n/d) 	title_menu="${prefixentry} ${name_snapshot} ${snap_date_time}";;
 		p/d) 	title_menu="${prefixentry} ${snap_date_time}";;
 		p/n) 	title_menu="${prefixentry} ${name_snapshot}";;
 		d/n) 	title_menu="${snap_date_time} ${name_snapshot}";;
 		n/d) 	title_menu="${name_snapshot} ${snap_date_time}";;
-		p) 	title_menu="${prefixentry}";;
-		d)	title_menu="${snap_date_time}";;
-		n)	title_menu="${name_snapshot}";;
-		*)	printf $"# Warning: GRUB_BTRFS_TITLE_FORMAT=${title_format}, syntax error \n" >&2
+		p) 		title_menu="${prefixentry}";;
+		d)		title_menu="${snap_date_time}";;
+		n)		title_menu="${name_snapshot}";;
+		*)		title_menu="${prefixentry} ${snap_date_time} ${name_snapshot}"
 	esac
 }

@@ -421,7 +414,7 @@ boot_bounded()
 		snap_dir_name="$(trim "$snap_dir_name")"
 		snap_date_time="$(echo "$item" | cut -d' ' -f1-2)"
 		snap_date_time="$(trim "$snap_date_time")"
-		
+
 		boot_dir="$gbgmp/$snap_dir_name/boot"
 		# Kernel (Original + custom kernel)
 		detect_kernel
@@ -464,12 +457,12 @@ boot_separate()
 	detect_kernel
 	if [ -z "${list_kernel}" ]; then print_error "Kernels not found."; fi
 	name_kernel=("${list_kernel[@]##*"/"}")
-	
+
 	# Initramfs (Original + custom initramfs)
 	detect_initramfs
 	if [ -z "${list_initramfs}" ]; then print_error "Initramfs not found."; fi
 	name_initramfs=("${list_initramfs[@]##*"/"}")
-	
+
 	# microcode (auto-detect + custom microcode)
 	detect_microcode
 	name_microcode=("${list_ucode[@]##*"/"}")
@@ -509,8 +502,8 @@ printf "###### - Grub-btrfs: Snapshot detection started - ######\n" >&2 ;
 # if btrfs prog isn't installed, exit
 test_btrfs
 # Delete existing config
-#rm -f --preserve-root "/boot/grub/grub-btrfs.cfg"
-> "/boot/grub/grub-btrfs.cfg"
+#rm -f --preserve-root "/boot/$grub_directory/grub-btrfs.cfg"
+> "/boot/$grub_directory/grub-btrfs.cfg"
 # Create mount point then mounting
 [[ ! -d $gbgmp ]] && mkdir -p $gbgmp
 mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
@@ -518,13 +511,20 @@ mount -o subvolid=5 /dev/disk/by-uuid/$root_uuid $gbgmp/
 count_warning_menuentries=0
 # Count snapshots
 count_limit_snap=0
+# detect uuid requirement
+check_uuid_required
 # Detects if /boot is a separate partition
-if [[ "$root_uuid" != "$boot_uuid" ]]; then
-	printf "# Info: Separate boot partition detected \n" >&2 ;
+if [[ "$override_boot_partition_detection" == "true" ]]; then
+	printf "# Info: Override boot partition detection : enable \n" >&2 ;
 	boot_separate
 	else
-	printf "# Info: Separate boot partition not detected \n" >&2 ;
-	boot_bounded
+	if [[ "$root_uuid" != "$boot_uuid" ]]; then
+		printf "# Info: Separate boot partition detected \n" >&2 ;
+		boot_separate
+		else
+		printf "# Info: Separate boot partition not detected \n" >&2 ;
+		boot_bounded
+	fi
 fi
 # unmounting mount point
 umount $gbgmp
@@ -539,7 +539,7 @@ fi
 if [[ "${count_limit_snap}" = "0" || -z "${count_limit_snap}" ]]; then
 	print_error "No snapshots found."
 fi
-root_grub="$(make_system_path_relative_to_its_root /boot/grub)"
+root_grub="$(make_system_path_relative_to_its_root /boot/$grub_directory)"
 # Make a submenu in GRUB (grub.cfg)
 cat << EOF
 submenu '${submenuname}' {
--- a/19
+++ b/19
@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+# GRUB_BTRFS_SUBMENUNAME="Arch Linux snapshots"                              # Name appearing in the Grub menu
+# GRUB_BTRFS_PREFIXENTRY="Snapshot:"                                         # Add a name ahead your snapshots entries in the Grub menu
+# GRUB_BTRFS_DISPLAY_PATH_SNAPSHOT="true"                                    # Show full path snapshot or only name in the Grub menu
+# GRUB_BTRFS_TITLE_FORMAT="p/d/n"                                            # Custom title, shows/hides p"prefix" d"date" n"name" in the Grub menu, separator "/", custom order available
+# GRUB_BTRFS_LIMIT="50"                                                      # Limit the number of snapshots populated in the GRUB menu
+# GRUB_BTRFS_SUBVOLUME_SORT="descending"                                     # Sort the found subvolumes by newest first ("descending") or oldest first ("ascending") and show $GRUB_BTRFS_LIMIT first entries.
+# GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"                                     # Show snapshots found during run "grub-mkconfig"
+# GRUB_BTRFS_SHOW_TOTAL_SNAPSHOTS_FOUND="true"                               # Show Total of snapshots found during run "grub-mkconfig"
+# GRUB_BTRFS_NKERNEL=("vmlinuz-linux")                                       # Use only if you have custom kernel name
+# GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")    # Use only if you have custom initramfs name
+# GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")                                 # Use only if you have custom intel-ucode
+# GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")                         # Ignore specific path during run "grub-mkconfig"
+# GRUB_BTRFS_SNAPPER_CONFIG="root"                                           # Snapper's config name to use
+# GRUB_BTRFS_DISABLE="false"                                                 # Disable Grub-btrfs
+# GRUB_BTRFS_DIRNAME=grub                                                    # Might be grub2 on some systems ex. /boot/grub2/...
+# GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false"                       # Change to "true" if you have a boot partition in a different subvolume
+# GRUB_BTRFS_MKCONFIG=grub-mkconfig                                          # Might be 'grub2-mkconfig' on some systems
--- a/README.md
+++ b/README.md
@@ -2,14 +2,14 @@
  
 ## grub-btrfs

-This is a version 2.xx of grub-btrfs
+This is a version 3.xx of grub-btrfs
 ##### BTC donation address: 1Lbvz244WA8xbpHek9W2Y12cakM6rDe5Rt
 ##
 ### Description

 grub-btrfs, Include btrfs snapshots at boot options. (grub menu)
 ##
-### What does grub-btrfs v2.xx do :
+### What does grub-btrfs v3.xx do :

 Simple rollback using snapshots you made previously.

@@ -17,14 +17,15 @@ Simple rollback using snapshots you made previously.

 * Automatically Detect if "/boot" is in separate partition.

-* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots. (For custom name, see below.)
+* Automatically Detect kernel, initramfs and intel microcode in "/boot" directory on snapshots.

 * Automatically Create corresponding "menuentry" in grub.cfg , which ensures a very easy rollback.

 * Automatically detect snapper and use snapper's snapshot description if available.
 ##
-### How to use it:
+### How to customize it:

+You have the possibility to modify many parameters.
 Add this lines to /etc/default/grub:

 * GRUB_BTRFS_SUBMENUNAME="Arch Linux Snapshots"
@@ -43,17 +44,17 @@ Add this lines to /etc/default/grub:

 	(Custom title, shows/hides p"prefix" d"date" n"name" in grub-menu, separator "/", custom order available)

-* GRUB_BTRFS_NKERNEL=("vmlinuz-linux")
+* GRUB_BTRFS_NKERNEL=("kernel-custom")

-	(Use only if you have a custom kernel name or auto-detect failed.)
+	(Use it only if you have a custom kernel name)

-* GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")
+* GRUB_BTRFS_NINIT=("initramfs-custom.img" "initrd.img-custom")

-	(Use only if you have a custom initramfs name or auto-detect failed.)
+	(Use it only if you have a custom initramfs name)

 * GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")

-	(Use only if you have custom intel-ucode or auto-detect failed.)
+	(Use it only if you have custom intel-ucode)

 * GRUB_BTRFS_LIMIT="50"

@@ -73,18 +74,28 @@ Add this lines to /etc/default/grub:
 	
 	(Show Total number of snapshots found during run "grub-mkconfig")

-* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot")
+* GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")

 	(Ignore specific path during run "grub-mkconfig")

-* GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES="true"
-
-	(Create entries with matching version number instead of all possible combinations of kernel and initramfs, very useful with debian-like distributions)
-
 * GRUB_BTRFS_SNAPPER_CONFIG="root"													

 	(Snapper's config name to use)

+* GRUB_BTRFS_DISABLE="true"
+
+	(Disable grub-btrfs)
+
+* GRUB_BTRFS_DIRNAME="grub"
+
+	(Name of the grub folder on /boot/)
+
+* GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false"
+	(Change to "true" if you have a boot partition in a different subvolume)
+
+* GRUB_BTRFS_MKCONFIG=grub-mkconfig
+
+    (Name or path of the 'grub-mkconfig' executable; this is 'grub2-mkconfig' on some systems)

 Generate grub.cfg (on Arch linux use grub-mkconfig -o /boot/grub/grub.cfg )

@@ -99,6 +110,8 @@ If you would like grub to automatically update when Snapper timeline snapshots a
 - `/etc/systemd/system/snapper-timeline.service.d/`
 - `/etc/systemd/system/snapper-cleanup.service.d/`

+Or copy `grub-btrfs.path` and `grub-btrfs.service` to `/etc/systemd/system/`
+
 Once the configuration files are in place, `systemctl daemon-reload` should be run to reload the units and make the changes active.

 ##
--- a/grub-btrfs.path
+++ b/grub-btrfs.path
@@ -0,0 +1,8 @@
+[Unit]
+Description=Monitors for new snapshots
+
+[Path]
+PathModified=/.snapshots
+
+[Install]
+WantedBy=multi-user.target
--- a/grub-btrfs.service
+++ b/grub-btrfs.service
@@ -0,0 +1,11 @@
+[Unit]
+Description=Regenerate grub-btrfs.cfg
+
+[Service]
+Type=oneshot
+# Set the possible paths for `grub-mkconfig`
+Environment="PATH=/sbin:/bin:/usr/sbin:/usr/bin"
+# Load environment variables from the configuration
+EnvironmentFile=/etc/grub.d/41_snapshots-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 "/boot/${GRUB_BTRFS_DIRNAME:-grub}/grub-btrfs.cfg" ]; then /etc/grub.d/41_snapshots-btrfs; else ${GRUB_BTRFS_MKCONFIG:-/usr/bin/grub-mkconfig} -o /boot/${GRUB_BTRFS_DIRNAME:-grub}/grub.cfg; fi'
Author	SHA1	Message	Date
Maxim Baz	3eb7eb7861	Support snapper 0.7.0 (#57 ) Snapper changed the order of columns, ID now comes before type.	2018-10-24 00:29:06 +02:00
Nathan Parsons	35703e71c1	Make 'grub-mkconfig' command name configurable (#56 ) * Make 'grub-mkconfig' command name configurable - Use 'grub-mkconfig' as the default - Note that some systems use 'grub2-mkconfig' - Update 10-update_grub.conf to use the configurable grub directory name - Refactor the systemd commands for clarity and to avoid duplicate regeneration on first run * Update check_uuid_required() to work for partial regeneration of the GRUB menu	2018-08-15 14:02:13 +02:00
Antynea	a1a48d26b7	Override boot partition detection (#55 ) * Override boot partition detection refer to #54 * Add new option # GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false" # Change to "true" if you have a boot partition in a different subvolume * Corrects indentation * Update readme GRUB_BTRFS_OVERRIDE_BOOT_PARTITION_DETECTION="false" (Change to "true" if you have a boot partition in a different subvolume)	2018-07-09 18:55:09 +02:00
Crafter6432	13a7186aaf	Add systemd.path as option to monitor for new Snapshots (#53 ) * Use systemd.path to regenerate grub-btrfs.cfg * Added option GRUB_BTRFS_DIRNAME * Updated README	2018-06-30 14:46:30 +02:00
Antynea	9b73e0ac62	Check uuid requirement. (#52 ) * detect uuid requirement add new function to detect uuid requirement * Reduce generation time New function doesn't need to be called at each generation of a menu entry	2018-06-11 15:52:00 +02:00
Maxim Baz	b17e7bd6a1	Add a dedicated config file (#49 )	2018-04-20 18:08:37 +02:00
Antynea	b8325cf134	Fix: some functions doesn't work as expected (#48 ) * Fix: Title format in grub-menu function: - title_format , doesn't work as expected replace print message with default parameter (p/d/n) * Update header - Add Github link - Clear up some explanations * Fix: path to grub-mkconfig_lib . "$pkgdatadir/grub-mkconfig_lib" doesn't work on some distribution Replaced by . "$datarootdir/grub/grub-mkconfig_lib" * Fix: matches kernel & initramfs matches kernel & initramfs doesn't work as expected	2018-04-19 15:45:59 +02:00
Antynea	c5da4014ae	Update readme to v3.xx Update readme to v3.xx GRUB_BTRFS_CREATE_ONLY_HARMONIZED_ENTRIES="true" Doesn't exist anymore GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker" "nosnapshot") Delete "nosnapshot" it is confusing New option available : GRUB_BTRFS_DISABLE="true" (Disable grub-btrfs)	2018-04-17 12:18:56 +02:00