In source code comments, change "Multiboot" to "Multiboot2".

This forced us to touch the completely wrongly placed comment
on the 'flags' in multiboot2.h, so we have moved that comment
where it belongs and added comments for the groups of macro
definitions which now had no comments at all.

Signed-off-by: Hans Ulrich Niedermann <h...@n-dimensional.de>

diff --git a/doc/boot_i386.S b/doc/boot_i386.S
index c6e7f1382..20a600a6e 100644
--- a/doc/boot_i386.S
+++ b/doc/boot_i386.S
@@ -38,7 +38,7 @@ _start:
        /* Align 64 bits boundary.  */
        .balign 8
        
-       /* Multiboot header.  */
+       /* Multiboot2 header.  */
 multiboot_header:
        /* magic */
        .long   MULTIBOOT2_HEADER_MAGIC
@@ -94,7 +94,7 @@ multiboot_entry:
        pushl   $0
        popf
 
-       /* Push the pointer to the Multiboot information structure.  */
+       /* Push the pointer to the Multiboot2 information structure.  */
        pushl   %ebx
        /* Push the magic value.  */
        pushl   %eax
diff --git a/doc/boot_mips.S b/doc/boot_mips.S
index 2b9ee0f9c..3f99c81a0 100644
--- a/doc/boot_mips.S
+++ b/doc/boot_mips.S
@@ -41,7 +41,7 @@ _start:
        /* Align 64 bits boundary.  */
        .balign 8
        
-       /* Multiboot header.  */
+       /* Multiboot2 header.  */
 multiboot_header:
        /* magic */
        .long   MULTIBOOT2_HEADER_MAGIC
diff --git a/doc/kernel.c b/doc/kernel.c
index c9431e3c0..d555fbe06 100644
--- a/doc/kernel.c
+++ b/doc/kernel.c
@@ -44,7 +44,7 @@ static void itoa (char *buf, int base, int d);
 static void putchar (int c);
 void printf (const char *format, ...);
 
-/* Check if MAGIC is valid and print the Multiboot information structure
+/* Check if MAGIC is valid and print the Multiboot2 information structure
    pointed by ADDR.  */
 void
 cmain (unsigned long magic, unsigned long addr)
@@ -55,7 +55,7 @@ cmain (unsigned long magic, unsigned long addr)
   /* Clear the screen.  */
   cls ();
 
-  /* Am I booted by a Multiboot-compliant boot loader?  */
+  /* Am I booted by a Multiboot2-compliant boot loader?  */
   if (magic != MULTIBOOT2_BOOTLOADER_MAGIC)
     {
       printf ("Invalid magic number: 0x%x\n", (unsigned) magic);
diff --git a/doc/multiboot2.h b/doc/multiboot2.h
index b18160707..d3b03d7a1 100644
--- a/doc/multiboot2.h
+++ b/doc/multiboot2.h
@@ -32,14 +32,13 @@
 /* This should be in %eax.  */
 #define MULTIBOOT2_BOOTLOADER_MAGIC            0x36d76289
 
-/* Alignment of multiboot modules.  */
+/* Alignment of multiboot2 modules.  */
 #define MULTIBOOT_MOD_ALIGN                    0x00001000
 
-/* Alignment of the multiboot info structure.  */
+/* Alignment of the multiboot2 info structure.  */
 #define MULTIBOOT_INFO_ALIGN                   0x00000008
 
-/* Flags set in the 'flags' member of the multiboot header.  */
-
+/* Multiboot2 boot information tag types */
 #define MULTIBOOT_TAG_ALIGN                  8
 #define MULTIBOOT_TAG_TYPE_END               0
 #define MULTIBOOT_TAG_TYPE_CMDLINE           1
@@ -64,6 +63,7 @@
 #define MULTIBOOT_TAG_TYPE_EFI64_IH          20
 #define MULTIBOOT_TAG_TYPE_LOAD_BASE_ADDR    21
 
+/* Multiboot2 header tag types */
 #define MULTIBOOT_HEADER_TAG_END  0
 #define MULTIBOOT_HEADER_TAG_INFORMATION_REQUEST  1
 #define MULTIBOOT_HEADER_TAG_ADDRESS  2
@@ -76,14 +76,19 @@
 #define MULTIBOOT_HEADER_TAG_ENTRY_ADDRESS_EFI64  9
 #define MULTIBOOT_HEADER_TAG_RELOCATABLE  10
 
+/* values for Multiboot2 header architecture field */
 #define MULTIBOOT_ARCHITECTURE_I386  0
 #define MULTIBOOT_ARCHITECTURE_MIPS32  4
+
+/* Flag set in the 'flags' member of the multiboot2 header tag. */
 #define MULTIBOOT_HEADER_TAG_OPTIONAL 1
 
+/* Values for the Multiboot2 relocateable header tag preference field */
 #define MULTIBOOT_LOAD_PREFERENCE_NONE 0
 #define MULTIBOOT_LOAD_PREFERENCE_LOW 1
 #define MULTIBOOT_LOAD_PREFERENCE_HIGH 2
 
+/* Flags for the Multiboot2 (console) flags tag */
 #define MULTIBOOT_CONSOLE_FLAGS_CONSOLE_REQUIRED 1
 #define MULTIBOOT_CONSOLE_FLAGS_EGA_TEXT_SUPPORTED 2
 
-- 
2.26.2


_______________________________________________
Grub-devel mailing list
Grub-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/grub-devel

Reply via email to