From 819cd3f41cacd487e927f7e2bad24b26750e4387 Mon Sep 17 00:00:00 2001
From: Michael Brown
Date: Thu, 11 Jan 2007 17:06:25 +0000
Subject: Limit -ENOEXEC to mean "this is not in my format".

---
 src/include/gpxe/image.h | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/include')

diff --git a/src/include/gpxe/image.h b/src/include/gpxe/image.h
index 6bb6b0124..22f8939f1 100644
--- a/src/include/gpxe/image.h
+++ b/src/include/gpxe/image.h
@@ -40,6 +40,14 @@ struct image_type {
 	 * discarded after this call; the method must preserve any
 	 * information it may require later (e.g. the execution
 	 * address) within the @c image structure.
+	 *
+	 * The method should return -ENOEXEC if and only if the image
+	 * is not in the correct format.  Other errors will be
+	 * interpreted as "I claim this image format, but there's
+	 * something wrong with it that makes it unloadable".  In
+	 * particular, returning -ENOEXEC will cause the image probing
+	 * code to try the next available image type, while returning
+	 * any other error will terminate image probing.
 	 */
 	int ( * load ) ( struct image *image );
 };
-- 
cgit v1.2.3-55-g7522