Clean code

Clean indentation/leading/trailing space

41_snapshots-btrfs

@@ -10,7 +10,8 @@
 #   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 : it isn't recommended to start on read-only snapshot
+#   Warning : booting on read-only snapshots can be tricky
+#   (If you choose to do it, /var/log must be on a separate subvolume.Otherwise, make sure your snapshots are writeable.)
 #
 # What this script does:
 # - Automatically List snapshots existing on root partition (btrfs).
@@ -71,15 +72,11 @@ nkernel=("${GRUB_BTRFS_NKERNEL[@]}")
 ## Initramfs name(s)
 ninit=("${GRUB_BTRFS_NINIT[@]}")
 ## Microcode(s) name(s)
-microcode=("${GRUB_BTRFS_INTEL_UCODE[@]}")
+microcode=("${GRUB_BTRFS_CUSTOM_MICROCODE[@]}")
 ## Limit snapshots to show in the Grub menu
 limit_snap_show="${GRUB_BTRFS_LIMIT:-50}"
 ## How to sort snapshots list
-snap_list_sort=${GRUB_BTRFS_SUBVOLUME_SORT:-"descending"}
-case "${snap_list_sort}" in
-    ascending)          btrfssubvolsort=("--sort=+rootid");;
-    *)                  btrfssubvolsort=("--sort=-rootid")
-esac
+btrfssubvolsort=(--sort="${GRUB_BTRFS_SUBVOLUME_SORT:-"-rootid"}")
 ## Show snapshots found during run "grub-mkconfig"
 show_snap_found=${GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND:-"true"}
 ## Show Total of snapshots found during run "grub-mkconfig"
@@ -108,9 +105,6 @@ fi
 ########################
 ### variables script ###
 ########################
-## Internationalization (default : english)
-export TEXTDOMAIN=grub-btrfs-git
-export TEXTDOMAINDIR="/usr/share/locale"
 ## Probe info "Boot partition"
 # Boot device
 boot_device=$(${grub_probe} --target=device /boot)
@@ -151,8 +145,8 @@ fi
 print_error()
 {
 	local arg="$@"
-	local nothing_to_do="If you think an error has occurred , please file a bug report at \" https://github.com/Antynea/grub-btrfs \"\n# Nothing to do. Abort.\n###### - Grub-btrfs: Snapshot detection ended   - ######\n"
-	printf "# ${arg}\n# ${nothing_to_do}" >&2 ;
+	local nothing_to_do="If you think an error has occurred , please file a bug report at \" https://github.com/Antynea/grub-btrfs \"\nNothing to do. Abort.\n"
+	printf "${arg}\n${nothing_to_do}" >&2 ;
 	exit 0
 }
 
@@ -201,7 +195,7 @@ make_menu_entries()
 			else 	continue ;
 			fi
 			for u in "${name_microcode[@]}"; do
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
+				if [[ "${name_microcode}" != "x" ]] ; then
 				entry "
 	menuentry '"${k}" & "${i}" & "${u}"' ${CLASS} "\$menuentry_id_option" 'gnulinux-snapshots-$boot_uuid' {"
 				else
@@ -222,7 +216,7 @@ make_menu_entries()
 		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}"\""
-				if [[ -f "${boot_dir}"/"${u}" && "${i}" != "${prefix_i}-${kversion}-${alt_suffix_i}" ]] ; then
+				if [[ "${name_microcode}" != "x" ]] ; then
 					entry "\
 		echo 'Loading Microcode & Initramfs: "${u}" "${i}" ...'
 		initrd \"${boot_dir_root_grub}/"${u}"\" \"${boot_dir_root_grub}/"${i}"\""
@@ -254,14 +248,14 @@ snapshot_list()
 	type snapper >/dev/null 2>&1
 	if [ $? -eq 0 ]; then
 		if [ -s "/etc/snapper/configs/$snapper_config" ]; then
-			printf "# Info: snapper detected, using config '$snapper_config'\n" >&2
+			printf "Info: snapper detected, using config '$snapper_config'\n" >&2
 			local snapper_ids=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | cut -d'|' -f 1))
 			local snapper_types=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | cut -d'|' -f 2))
 
 			IFS=$'\n'
 			local snapper_descriptions=($(snapper --no-dbus -t 0 -c "$snapper_config" list --disable-used-space | tail -n +3 | rev | cut -d'|' -f 2 | rev))
 		else
-			printf "# Warning: snapper detected but config '$snapper_config' does not exist\n" >&2
+			printf "Warning: snapper detected but config '$snapper_config' does not exist\n" >&2
 		fi
 	fi
 
@@ -343,8 +337,8 @@ detect_kernel()
 	list_kernel=()
 	# Original kernel (auto-detect)
 	for okernel in	"${boot_dir}"/vmlinuz-* \
-			"${boot_dir}"/vmlinux-* \
-			"${boot_dir}"/kernel-* ; do
+					"${boot_dir}"/vmlinux-* \
+					"${boot_dir}"/kernel-* ; do
 		[[ ! -f "${okernel}" ]] && continue;
 		list_kernel+=("$okernel")
 	done
@@ -364,10 +358,10 @@ detect_initramfs()
 	list_initramfs=()
 	# Original initramfs (auto-detect)
 	for oinitramfs in	"${boot_dir}"/initrd.img-* \
-				"${boot_dir}"/initrd-*.img \
-				"${boot_dir}"/initrd-*.gz \
-				"${boot_dir}"/initramfs-*.img \
-				"${boot_dir}"/initramfs-*.gz ; do
+						"${boot_dir}"/initrd-*.img \
+						"${boot_dir}"/initrd-*.gz \
+						"${boot_dir}"/initramfs-*.img \
+						"${boot_dir}"/initramfs-*.gz ; do
 		[[ ! -f "${oinitramfs}" ]] && continue;
 		list_initramfs+=("$oinitramfs")
 	done
@@ -385,8 +379,14 @@ detect_initramfs()
 detect_microcode()
 {
 	list_ucode=()
-	# Original intel microcode
-	for oiucode in "${boot_dir}"/intel-ucode.img ; do
+	# Original intel/amd microcode (auto-detect)
+	# See "https://www.gnu.org/software/grub/manual/grub/html_node/Simple-configuration.html"
+	for oiucode in  "${boot_dir}"/intel-uc.img \
+					"${boot_dir}"/intel-ucode.img \
+					"${boot_dir}"/amd-uc.img \
+					"${boot_dir}"/amd-ucode.img \
+					"${boot_dir}"/early_ucode.cpio \
+					"${boot_dir}"/microcode.cpio; do
 		[[ ! -f "${oiucode}" ]] && continue;
 		list_ucode+=("$oiucode")
 	done
@@ -440,7 +440,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
@@ -450,12 +450,12 @@ boot_bounded()
 		detect_initramfs
 		if [ -z "${list_initramfs}" ]; then continue; fi
 		name_initramfs=("${list_initramfs[@]##*"/"}")
-		# microcode (intel-ucode + custom microcode)
+		# microcode (auto-detect + custom microcode)
 		detect_microcode
 		name_microcode=("${list_ucode[@]##*"/"}")
 		# show snapshot found during run "grub-mkconfig"
 		if [[ "${show_snap_found}" = "true" ]]; then
-		printf $"# Found snapshot: %s\n" "$item" >&2 ;
+		printf "Found snapshot: %s\n" "$item" >&2 ;
 		fi
 		# Show full path snapshot or only name
 		path_snapshot
@@ -466,8 +466,8 @@ boot_bounded()
 		# Make menuentries
 		make_menu_entries
 		### Limit snapshots found during run "grub-mkconfig"
-	        count_limit_snap=$((1+$count_limit_snap))
-	        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+		count_limit_snap=$((1+$count_limit_snap))
+		[[ $count_limit_snap -ge $limit_snap_show ]] && break;
 		# Limit generation of menuentries if exceeds 250
 		# [[ $count_warning_menuentries -ge 250 ]] && break;
 	done
@@ -506,7 +506,7 @@ boot_separate()
 		snap_date_time="$(trim "$snap_date_time")"
 		# show snapshot found during run "grub-mkconfig"
 		if [[ "${show_snap_found}" = "true" ]]; then
-		printf $"# Found snapshot: %s\n" "$item" >&2 ;
+		printf "Found snapshot: %s\n" "$item" >&2 ;
 		fi
 		# Show full path snapshot or only name
 		path_snapshot
@@ -516,7 +516,7 @@ boot_separate()
 		make_menu_entries
 		# Limit snapshots found during run "grub-mkconfig"
 		count_limit_snap=$((1+$count_limit_snap))
-	        [[ $count_limit_snap -ge $limit_snap_show ]] && break;
+		[[ $count_limit_snap -ge $limit_snap_show ]] && break;
 		# Limit generation of menuentries if exceeds 250
 		# [[ $count_warning_menuentries -ge 250 ]] && break;
 	done
@@ -524,7 +524,7 @@ boot_separate()
 }
 
 ### Start ###
-printf "###### - Grub-btrfs: Snapshot detection started - ######\n" >&2 ;
+printf "Detecting snapshots ...\n" >&2 ;
 # if btrfs prog isn't installed, exit
 test_btrfs
 # Delete existing config
@@ -541,36 +541,34 @@ count_limit_snap=0
 check_uuid_required
 # Detects if /boot is a separate partition
 if [[ "$override_boot_partition_detection" == "true" ]]; then
-	printf "# Info: Override boot partition detection : enable \n" >&2 ;
+	printf "Info: Override boot partition detection : enable \n" >&2 ;
 	boot_separate
 else
 	if [[ "$root_uuid" != "$boot_uuid" ]]; then
-		printf "# Info: Separate boot partition detected \n" >&2 ;
+		printf "Info: Separate boot partition detected \n" >&2 ;
 		boot_separate
 	else
-		printf "# Info: Separate boot partition not detected \n" >&2 ;
+		printf "Info: Separate boot partition not detected \n" >&2 ;
 		boot_bounded
 	fi
 fi
 # unmounting mount point
 umount $gbgmp
 # Show warn, menuentries exceeds 250 entries
-[[ $count_warning_menuentries -ge 250 ]] && printf "# Generated ${count_warning_menuentries} total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" >&2 ;
-# printf "# menuentries = $count_warning_menuentries \n" >&2 ;
+[[ $count_warning_menuentries -ge 250 ]] && printf "Generated ${count_warning_menuentries} total GRUB entries. You might experience issues loading snapshots menu in GRUB.\n" >&2 ;
+# printf "menuentries = $count_warning_menuentries \n" >&2 ;
 # Show total found snapshots
 if [[ "${show_total_snap_found}" = "true" && ! -z "${count_limit_snap}" && "${count_limit_snap}" != "0" ]]; then
-	printf "# Found ${count_limit_snap} snapshot(s)\n" >&2 ;
+	printf "Found ${count_limit_snap} snapshot(s)\n" >&2 ;
 fi
 # if no snapshot found, exit
 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_directory)"
 # Make a submenu in GRUB (grub.cfg)
 cat << EOF
 submenu '${submenuname}' ${protection_authorized_users}${unrestricted_access_submenu}{
 	configfile "\${prefix}/grub-btrfs.cfg"
 }
 EOF
-printf "###### - Grub-btrfs: Snapshot detection ended   - ######\n" >&2 ;
 ### End ###

README.md

@@ -24,7 +24,7 @@ See [this ticket](https://github.com/Antynea/grub-btrfs/issues/92) for more info
 ### What does grub-btrfs v4.xx do :
 * 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 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.
@@ -69,13 +69,13 @@ You have the possibility to modify many parameters in `/etc/default/grub-btrfs/c
 
 	Limit the number of snapshots populated in the GRUB menu.
 
-* GRUB_BTRFS_SUBVOLUME_SORT="descending"
+* GRUB_BTRFS_SUBVOLUME_SORT="+ogen,-gen,path,rootid"
 
-	Sort the found subvolumes by newest first ("descending") or oldest first ("ascending"). 
+	Sort the found subvolumes by "ogeneration" or "generation" or "path" or "rootid".
 	
-	If "ascending" is chosen then 
+	Default: "-rootid" means list snapshot by new ones first
 	
-	the $GRUB_BTRFS_LIMIT oldest subvolumes will populate the menu.
+	See [Sorting section](https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-subvolume#SUBCOMMAND)
 
 * GRUB_BTRFS_SHOW_SNAPSHOTS_FOUND="true"
 	
@@ -93,9 +93,9 @@ You have the possibility to modify many parameters in `/etc/default/grub-btrfs/c
 
 	Use it only if you have a custom initramfs name.
 
-* GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
+* GRUB_BTRFS_CUSTOM_MICROCODE=("intel-ucode.img")
 
-	Use it only if you have custom intel-ucode.
+	Use it only if you have custom microcode.
 
 * GRUB_BTRFS_IGNORE_SPECIFIC_PATH=("var/lib/docker")
 

config

@@ -21,9 +21,10 @@
 # Default: "50"
 #GRUB_BTRFS_LIMIT="50"
 
-# Sort the found subvolumes by newest first ("descending") or oldest first ("ascending") and show $GRUB_BTRFS_LIMIT first entries.
-# Default: "descending"
-#GRUB_BTRFS_SUBVOLUME_SORT="descending"
+# Sort the found subvolumes by "ogeneration" or "generation" or "path" or "rootid"
+# Default: "-rootid"
+# See Sorting section to https://btrfs.wiki.kernel.org/index.php/Manpage/btrfs-subvolume#SUBCOMMAND
+#GRUB_BTRFS_SUBVOLUME_SORT="+ogen,-gen,path,rootid"
 
 # Show snapshots found during run "grub-mkconfig"
 # Default: "true"
@@ -41,9 +42,9 @@
 # Default:
 #GRUB_BTRFS_NINIT=("initramfs-linux.img" "initramfs-linux-fallback.img")
 
-# Use only if you have custom intel-ucode
+# Use only if you have custom microcode
 # Default:
-#GRUB_BTRFS_INTEL_UCODE=("intel-ucode.img")
+#GRUB_BTRFS_CUSTOM_MICROCODE=("intel-ucode.img")
 
 # Ignore specific path during run "grub-mkconfig".
 # If path is a directory, # Found Snapshot: 2016-03-31 10:24:41 var/lib/docker/btrfs/subvolumes/...