Skip to content

Commit a146bb4

Browse files
docs: move x86 documentation into Documentation/arch/
JIRA: https://issues.redhat.com/browse/RHEL-15513 Conflicts: This is a partial backport of the referenced upstream commit that just includes the move of Documentation/x86/boot.rst to Documentation/arch/x86/boot.rst and its in-kernel references. Additionally, since Documentation/x86/index.rst has not been moved, its reference to boot.rst is updated to its new location. commit ff61f07 Author: Jonathan Corbet <corbet@lwn.net> Date: Tue Mar 14 17:06:44 2023 -0600 docs: move x86 documentation into Documentation/arch/ Move the x86 documentation under Documentation/arch/ as a way of cleaning up the top-level directory and making the structure of our docs more closely match the structure of the source directories it describes. All in-kernel references to the old paths have been updated. Acked-by: Dave Hansen <dave.hansen@linux.intel.com> Cc: linux-arch@vger.kernel.org Cc: x86@kernel.org Cc: Borislav Petkov <bp@alien8.de> Cc: Thomas Gleixner <tglx@linutronix.de> Link: https://lore.kernel.org/lkml/20230315211523.108836-1-corbet@lwn.net/ Signed-off-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Lenny Szubowicz <lszubowi@redhat.com>
1 parent 8ef5f2b commit a146bb4

File tree

10 files changed

+10
-10
lines changed

10 files changed

+10
-10
lines changed

Documentation/admin-guide/kernel-parameters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ In addition, the following text indicates that the option::
196196
Parameters denoted with BOOT are actually interpreted by the boot
197197
loader, and have no meaning to the kernel directly.
198198
Do not modify the syntax of boot loader parameters without extreme
199-
need or coordination with <Documentation/x86/boot.rst>.
199+
need or coordination with <Documentation/arch/x86/boot.rst>.
200200

201201
There are also arch-specific kernel-parameters not documented here.
202202
See for example <Documentation/x86/x86_64/boot-options.rst>.

Documentation/admin-guide/kernel-parameters.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6680,7 +6680,7 @@
66806680
Can be used multiple times for multiple devices.
66816681

66826682
vga= [BOOT,X86-32] Select a particular video mode
6683-
See Documentation/x86/boot.rst and
6683+
See Documentation/arch/x86/boot.rst and
66846684
Documentation/admin-guide/svga.rst.
66856685
Use vga=ask for menu.
66866686
This is actually a boot loader parameter; the value is

Documentation/admin-guide/sysctl/kernel.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ is 0x15 and the full version number is 0x234, this file will contain
9090
the value 340 = 0x154.
9191

9292
See the ``type_of_loader`` and ``ext_loader_type`` fields in
93-
Documentation/x86/boot.rst for additional information.
93+
Documentation/arch/x86/boot.rst for additional information.
9494

9595

9696
bootloader_version (x86 only)
@@ -100,7 +100,7 @@ The complete bootloader version number. In the example above, this
100100
file will contain the value 564 = 0x234.
101101

102102
See the ``type_of_loader`` and ``ext_loader_ver`` fields in
103-
Documentation/x86/boot.rst for additional information.
103+
Documentation/arch/x86/boot.rst for additional information.
104104

105105

106106
bpf_stats_enabled
File renamed without changes.

Documentation/x86/booting-dt.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ DeviceTree Booting
77
the decompressor (the real mode entry point goes to the same 32bit
88
entry point once it switched into protected mode). That entry point
99
supports one calling convention which is documented in
10-
Documentation/x86/boot.rst
10+
Documentation/arch/x86/boot.rst
1111
The physical pointer to the device-tree block is passed via setup_data
1212
which requires at least boot protocol 2.09.
1313
The type filed is defined as

Documentation/x86/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ x86-specific Documentation
88
:maxdepth: 2
99
:numbered:
1010

11-
boot
11+
../arch/x86/boot
1212
booting-dt
1313
cpuinfo
1414
topology

arch/x86/boot/header.S

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ start_sys_seg: .word SYSSEG # obsolete and meaningless, but just
321321

322322
type_of_loader: .byte 0 # 0 means ancient bootloader, newer
323323
# bootloaders know to change this.
324-
# See Documentation/x86/boot.rst for
324+
# See Documentation/arch/x86/boot.rst for
325325
# assigned ids
326326

327327
# flags, unused bits must be zero (RFU) bit within loadflags

arch/x86/include/asm/bootparam_utils.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ static void sanitize_boot_params(struct boot_params *boot_params)
3838
* IMPORTANT NOTE TO BOOTLOADER AUTHORS: do not simply clear
3939
* this field. The purpose of this field is to guarantee
4040
* compliance with the x86 boot spec located in
41-
* Documentation/x86/boot.rst . That spec says that the
41+
* Documentation/arch/x86/boot.rst . That spec says that the
4242
* *whole* structure should be cleared, after which only the
4343
* portion defined by struct setup_header (boot_params->hdr)
4444
* should be copied in.

arch/x86/kernel/kexec-bzimage64.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ static void *bzImage64_load(struct kimage *image, char *kernel,
408408
efi_map_offset = params_cmdline_sz;
409409
efi_setup_data_offset = efi_map_offset + ALIGN(efi_map_sz, 16);
410410

411-
/* Copy setup header onto bootparams. Documentation/x86/boot.rst */
411+
/* Copy setup header onto bootparams. Documentation/arch/x86/boot.rst */
412412
setup_header_size = 0x0202 + kernel[0x0201] - setup_hdr_offset;
413413

414414
/* Is there a limit on setup header size? */

arch/x86/platform/pvh/enlighten.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ static void __init init_pvh_bootparams(bool xen_guest)
8686
}
8787

8888
/*
89-
* See Documentation/x86/boot.rst.
89+
* See Documentation/arch/x86/boot.rst.
9090
*
9191
* Version 2.12 supports Xen entry point but we will use default x86/PC
9292
* environment (i.e. hardware_subarch 0).

0 commit comments

Comments
 (0)