From 3dac699970d4adf0ac0ec32b121123cb67108bbd Mon Sep 17 00:00:00 2001
From: Matthias Schiffer <mschiffer@universe-factory.net>
Date: Sat, 6 Apr 2024 12:08:08 +0200
Subject: driver: recipe: add comment regarding file sorting

---
 crates/driver/src/recipe.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/crates/driver/src/recipe.rs b/crates/driver/src/recipe.rs
index aa728c8..16d3751 100644
--- a/crates/driver/src/recipe.rs
+++ b/crates/driver/src/recipe.rs
@@ -146,6 +146,8 @@ pub fn read_recipes<P: AsRef<Path>>(path: P) -> Result<HashMap<TaskID, Vec<TaskD
 
 	for entry in WalkDir::new(path)
 		.sort_by(|a, b| {
+			// Files are sorted first by stem, then by extension, so that
+			// recipe.yml will always be read before recipe.NAME.yml
 			let stem_cmp = a.path().file_stem().cmp(&b.path().file_stem());
 			let ext_cmp = a.path().extension().cmp(&b.path().extension());
 			stem_cmp.then(ext_cmp)
-- 
cgit v1.2.3