x86/boot/realmode: Fix a comment's incorrect file reference
PATCH 1/1 x86/boot/realmode: Fix a comment's incorrect file reference
Fix the comment for 'struct real_mode_header' to reference the correct assembly file, realmode/rm/header.S. The comment has always incorrectly referenced realmode.S, which doesn't exist, as defining the associated asm blob.
Specify the file's path relative to arch/x86 to avoid confusion with boot/header.S. Update the comment for 'struct trampoline_header' to also include the relative path to keep things consistent, and tweak the dual 64/32 reference so that it doesn't appear to be an extension of the relative path, i.e. avoid "realmode/rm/trampoline_32/64.S".
---
The other obvious fix would be to simply delete the comment, but I found the comment to be quite helpful even though it referenced the incorrect file. Without the comment, it's not immediately obvious that the struct is representative of an asm blob.
arch/x86/include/asm/realmode.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
arch/x86/include/asm/realmode.h +2 -2
@@ -14,7 +14,7 @@#include <linux/types.h> #include <asm/io.h> -/* This must match data at realmode.S */ +/* This must match data at realmode/rm/header.S */ struct real_mode_header {u32 text_start;u32 ro_end;
@@ -36,7 +36,7 @@ struct real_mode_header {#endif }; -/* This must match data at trampoline_32/64.S */ +/* This must match data at realmode/rm/trampoline_{32,64}.S */ struct trampoline_header {#ifdef CONFIG_X86_32 u32 start;
Signature · 1 line
2.24.0
[tip: x86/cleanups] x86/boot: Fix a comment's incorrect file reference
The following commit has been merged into the x86/cleanups branch of tip:
The following commit has been merged into the x86/cleanups branch of tip:
Commit-ID: 957a227d413b06130b7d57d1954d821edf6991c1 Gitweb: https://git.kernel.org/tip/957a227d413b06130b7d57d1954d821edf6991c1 Author: Sean Christopherson <[email protected]> AuthorDate: Tue, 26 Nov 2019 11:59:11 -08:00 Committer: Borislav Petkov <[email protected]> CommitterDate: Mon, 16 Dec 2019 14:09:33 +01:00
x86/boot: Fix a comment's incorrect file reference
Fix the comment for 'struct real_mode_header' to reference the correct assembly file, realmode/rm/header.S. The comment has always incorrectly referenced realmode.S, which doesn't exist, as defining the associated asm blob.
Specify the file's path relative to arch/x86 to avoid confusion with boot/header.S. Update the comment for 'struct trampoline_header' to also include the relative path to keep things consistent, and tweak the dual 64/32 reference so that it doesn't appear to be an extension of the relative path, i.e. avoid "realmode/rm/trampoline_32/64.S".
--- arch/x86/include/asm/realmode.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
arch/x86/include/asm/realmode.h +2 -2
@@ -14,7 +14,7 @@#include <linux/types.h> #include <asm/io.h> -/* This must match data at realmode.S */ +/* This must match data at realmode/rm/header.S */ struct real_mode_header {u32 text_start;u32 ro_end;
@@ -36,7 +36,7 @@ struct real_mode_header {#endif }; -/* This must match data at trampoline_32/64.S */ +/* This must match data at realmode/rm/trampoline_{32,64}.S */ struct trampoline_header {#ifdef CONFIG_X86_32 u32 start;