Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: boot.rst: fix warnings

Fix WARNING: Inline emphasis start-string without end-string.
This warning was due to wrong syntax being used.

Signed-off-by: Daniel W. S. Almeida <dwlsalmeida@gmail.com>
Link: https://lore.kernel.org/r/20191223033121.1584930-1-dwlsalmeida@gmail.com
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Daniel W. S. Almeida and committed by
Jonathan Corbet
e43630ed 1209f45f

+19 -19
+19 -19
Documentation/x86/boot.rst
··· 835 835 chunks of memory are occupied by kernel data. 836 836 837 837 Thus setup_indirect struct and SETUP_INDIRECT type were introduced in 838 - protocol 2.15. 838 + protocol 2.15:: 839 839 840 - struct setup_indirect { 841 - __u32 type; 842 - __u32 reserved; /* Reserved, must be set to zero. */ 843 - __u64 len; 844 - __u64 addr; 845 - }; 840 + struct setup_indirect { 841 + __u32 type; 842 + __u32 reserved; /* Reserved, must be set to zero. */ 843 + __u64 len; 844 + __u64 addr; 845 + }; 846 846 847 847 The type member is a SETUP_INDIRECT | SETUP_* type. However, it cannot be 848 848 SETUP_INDIRECT itself since making the setup_indirect a tree structure ··· 850 850 and stack space can be limited in boot contexts. 851 851 852 852 Let's give an example how to point to SETUP_E820_EXT data using setup_indirect. 853 - In this case setup_data and setup_indirect will look like this: 853 + In this case setup_data and setup_indirect will look like this:: 854 854 855 - struct setup_data { 856 - __u64 next = 0 or <addr_of_next_setup_data_struct>; 857 - __u32 type = SETUP_INDIRECT; 858 - __u32 len = sizeof(setup_data); 859 - __u8 data[sizeof(setup_indirect)] = struct setup_indirect { 860 - __u32 type = SETUP_INDIRECT | SETUP_E820_EXT; 861 - __u32 reserved = 0; 862 - __u64 len = <len_of_SETUP_E820_EXT_data>; 863 - __u64 addr = <addr_of_SETUP_E820_EXT_data>; 855 + struct setup_data { 856 + __u64 next = 0 or <addr_of_next_setup_data_struct>; 857 + __u32 type = SETUP_INDIRECT; 858 + __u32 len = sizeof(setup_data); 859 + __u8 data[sizeof(setup_indirect)] = struct setup_indirect { 860 + __u32 type = SETUP_INDIRECT | SETUP_E820_EXT; 861 + __u32 reserved = 0; 862 + __u64 len = <len_of_SETUP_E820_EXT_data>; 863 + __u64 addr = <addr_of_SETUP_E820_EXT_data>; 864 + } 864 865 } 865 - } 866 866 867 867 .. note:: 868 868 SETUP_INDIRECT | SETUP_NONE objects cannot be properly distinguished ··· 965 965 All kernel_info data should be part of this structure. Fixed size data have to 966 966 be put before kernel_info_var_len_data label. Variable size data have to be put 967 967 after kernel_info_var_len_data label. Each chunk of variable size data has to 968 - be prefixed with header/magic and its size, e.g.: 968 + be prefixed with header/magic and its size, e.g.:: 969 969 970 970 kernel_info: 971 971 .ascii "LToP" /* Header, Linux top (structure). */