From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Changbin Du <changbin.du@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
tglx@linutronix.de, mingo@redhat.com, bp@alien8.de,
x86@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 08/27] Documentation: x86: convert zero-page.txt to reST
Date: Sat, 27 Apr 2019 14:19:52 -0300 [thread overview]
Message-ID: <20190427141952.4727075e@coco.lan> (raw)
In-Reply-To: <20190426153150.21228-9-changbin.du@gmail.com>
Em Fri, 26 Apr 2019 23:31:31 +0800
Changbin Du <changbin.du@gmail.com> escreveu:
> This converts the plain text documentation to reStructuredText format and
> add it to Sphinx TOC tree. No essential content change.
>
> Signed-off-by: Changbin Du <changbin.du@gmail.com>
> ---
> Documentation/x86/index.rst | 1 +
> Documentation/x86/zero-page.rst | 45 +++++++++++++++++++++++++++++++++
> Documentation/x86/zero-page.txt | 40 -----------------------------
> 3 files changed, 46 insertions(+), 40 deletions(-)
> create mode 100644 Documentation/x86/zero-page.rst
> delete mode 100644 Documentation/x86/zero-page.txt
>
> diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst
> index 7b8388ebd43d..9a0b5f38ef6b 100644
> --- a/Documentation/x86/index.rst
> +++ b/Documentation/x86/index.rst
> @@ -14,3 +14,4 @@ Linux x86 Support
> kernel-stacks
> entry_64
> earlyprintk
> + zero-page
> diff --git a/Documentation/x86/zero-page.rst b/Documentation/x86/zero-page.rst
> new file mode 100644
> index 000000000000..70f10eabca86
> --- /dev/null
> +++ b/Documentation/x86/zero-page.rst
> @@ -0,0 +1,45 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=========
> +Zero Page
> +=========
> +The additional fields in struct boot_params as a part of 32-bit boot
> +protocol of kernel. These should be filled by bootloader or 16-bit
> +real-mode setup code of the kernel. References/settings to it mainly
> +are in::
> +
> + arch/x86/include/uapi/asm/bootparam.h
> +
> +=========== ===== ======================= ================================
Same comment that I made on a past patch: please extend the tail markup here...
> +Offset/Size Proto Name Meaning
> +
> +000/040 ALL screen_info Text mode or frame buffer information
> + (struct screen_info)
> +040/014 ALL apm_bios_info APM BIOS information (struct apm_bios_info)
> +058/008 ALL tboot_addr Physical address of tboot shared page
> +060/010 ALL ist_info Intel SpeedStep (IST) BIOS support information
> + (struct ist_info)
> +080/010 ALL hd0_info hd0 disk parameter, OBSOLETE!!
> +090/010 ALL hd1_info hd1 disk parameter, OBSOLETE!!
> +0A0/010 ALL sys_desc_table System description table (struct sys_desc_table),
> + OBSOLETE!!
> +0B0/010 ALL olpc_ofw_header OLPC's OpenFirmware CIF and friends
> +0C0/004 ALL ext_ramdisk_image ramdisk_image high 32bits
> +0C4/004 ALL ext_ramdisk_size ramdisk_size high 32bits
> +0C8/004 ALL ext_cmd_line_ptr cmd_line_ptr high 32bits
> +140/080 ALL edid_info Video mode setup (struct edid_info)
> +1C0/020 ALL efi_info EFI 32 information (struct efi_info)
> +1E0/004 ALL alt_mem_k Alternative mem check, in KB
> +1E4/004 ALL scratch Scratch field for the kernel setup code
> +1E8/001 ALL e820_entries Number of entries in e820_table (below)
> +1E9/001 ALL eddbuf_entries Number of entries in eddbuf (below)
> +1EA/001 ALL edd_mbr_sig_buf_entries Number of entries in edd_mbr_sig_buffer
> + (below)
> +1EB/001 ALL kbd_status Numlock is enabled
> +1EC/001 ALL secure_boot Secure boot is enabled in the firmware
> +1EF/001 ALL sentinel Used to detect broken bootloaders
> +290/040 ALL edd_mbr_sig_buffer EDD MBR signatures
> +2D0/A00 ALL e820_table E820 memory map table
> + (array of struct e820_entry)
> +D00/1EC ALL eddbuf EDD data (array of struct edd_info)
> +=========== ===== ======================= ================================
... and here.
After this change:
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> diff --git a/Documentation/x86/zero-page.txt b/Documentation/x86/zero-page.txt
> deleted file mode 100644
> index 68aed077f7b6..000000000000
> --- a/Documentation/x86/zero-page.txt
> +++ /dev/null
> @@ -1,40 +0,0 @@
> -The additional fields in struct boot_params as a part of 32-bit boot
> -protocol of kernel. These should be filled by bootloader or 16-bit
> -real-mode setup code of the kernel. References/settings to it mainly
> -are in:
> -
> - arch/x86/include/uapi/asm/bootparam.h
> -
> -
> -Offset Proto Name Meaning
> -/Size
> -
> -000/040 ALL screen_info Text mode or frame buffer information
> - (struct screen_info)
> -040/014 ALL apm_bios_info APM BIOS information (struct apm_bios_info)
> -058/008 ALL tboot_addr Physical address of tboot shared page
> -060/010 ALL ist_info Intel SpeedStep (IST) BIOS support information
> - (struct ist_info)
> -080/010 ALL hd0_info hd0 disk parameter, OBSOLETE!!
> -090/010 ALL hd1_info hd1 disk parameter, OBSOLETE!!
> -0A0/010 ALL sys_desc_table System description table (struct sys_desc_table),
> - OBSOLETE!!
> -0B0/010 ALL olpc_ofw_header OLPC's OpenFirmware CIF and friends
> -0C0/004 ALL ext_ramdisk_image ramdisk_image high 32bits
> -0C4/004 ALL ext_ramdisk_size ramdisk_size high 32bits
> -0C8/004 ALL ext_cmd_line_ptr cmd_line_ptr high 32bits
> -140/080 ALL edid_info Video mode setup (struct edid_info)
> -1C0/020 ALL efi_info EFI 32 information (struct efi_info)
> -1E0/004 ALL alt_mem_k Alternative mem check, in KB
> -1E4/004 ALL scratch Scratch field for the kernel setup code
> -1E8/001 ALL e820_entries Number of entries in e820_table (below)
> -1E9/001 ALL eddbuf_entries Number of entries in eddbuf (below)
> -1EA/001 ALL edd_mbr_sig_buf_entries Number of entries in edd_mbr_sig_buffer
> - (below)
> -1EB/001 ALL kbd_status Numlock is enabled
> -1EC/001 ALL secure_boot Secure boot is enabled in the firmware
> -1EF/001 ALL sentinel Used to detect broken bootloaders
> -290/040 ALL edd_mbr_sig_buffer EDD MBR signatures
> -2D0/A00 ALL e820_table E820 memory map table
> - (array of struct e820_entry)
> -D00/1EC ALL eddbuf EDD data (array of struct edd_info)
Thanks,
Mauro
next prev parent reply other threads:[~2019-04-27 17:20 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-26 15:31 [PATCH 00/27] Include linux x86 docs into Sphinx TOC tree Changbin Du
2019-04-26 15:31 ` [PATCH 01/27] Documentation: add Linux x86 docs to " Changbin Du
2019-04-26 16:16 ` Borislav Petkov
2019-04-27 2:43 ` Changbin Du
2019-04-26 15:31 ` [PATCH 02/27] Documentation: x86: convert boot.txt to reST Changbin Du
2019-04-27 14:31 ` Mauro Carvalho Chehab
2019-05-02 6:59 ` Changbin Du
2019-04-26 15:31 ` [PATCH 03/27] Documentation: x86: convert topology.txt " Changbin Du
2019-04-27 14:41 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 04/27] Documentation: x86: convert exception-tables.txt " Changbin Du
2019-04-27 14:48 ` Mauro Carvalho Chehab
2019-05-02 3:19 ` Changbin Du
2019-04-26 15:31 ` [PATCH 05/27] Documentation: x86: convert kernel-stacks " Changbin Du
2019-04-27 14:50 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 06/27] Documentation: x86: convert entry_64.txt " Changbin Du
2019-04-27 14:52 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 07/27] Documentation: x86: convert earlyprintk.txt " Changbin Du
2019-04-27 17:17 ` Mauro Carvalho Chehab
2019-05-02 3:27 ` Changbin Du
2019-04-26 15:31 ` [PATCH 08/27] Documentation: x86: convert zero-page.txt " Changbin Du
2019-04-27 17:19 ` Mauro Carvalho Chehab [this message]
2019-04-26 15:31 ` [PATCH 09/27] Documentation: x86: convert tlb.txt " Changbin Du
2019-04-27 17:21 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 10/27] Documentation: x86: convert mtrr.txt " Changbin Du
2019-04-27 17:32 ` Mauro Carvalho Chehab
2019-04-27 18:10 ` Mauro Carvalho Chehab
2019-05-02 5:03 ` Changbin Du
2019-04-26 15:31 ` [PATCH 11/27] Documentation: x86: convert pat.txt " Changbin Du
2019-04-27 17:51 ` Mauro Carvalho Chehab
2019-05-02 5:25 ` Changbin Du
2019-04-26 15:31 ` [PATCH 12/27] Documentation: x86: convert protection-keys.txt " Changbin Du
2019-04-27 17:53 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 13/27] Documentation: x86: convert intel_mpx.txt " Changbin Du
2019-04-27 17:54 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 14/27] Documentation: x86: convert amd-memory-encryption.txt " Changbin Du
2019-04-27 17:55 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 15/27] Documentation: x86: convert pti.txt " Changbin Du
2019-04-27 17:57 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 16/27] Documentation: x86: convert microcode.txt " Changbin Du
2019-04-27 17:58 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 17/27] Documentation: x86: convert resctrl_ui.txt " Changbin Du
2019-04-27 18:09 ` Mauro Carvalho Chehab
2019-05-02 5:37 ` Changbin Du
2019-04-26 15:31 ` [PATCH 18/27] Documentation: x86: convert orc-unwinder.txt " Changbin Du
2019-04-27 18:16 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 19/27] Documentation: x86: convert usb-legacy-support.txt " Changbin Du
2019-04-27 18:20 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 20/27] Documentation: x86: convert i386/IO-APIC.txt " Changbin Du
2019-04-27 18:24 ` Mauro Carvalho Chehab
2019-05-02 5:42 ` Changbin Du
2019-04-26 15:31 ` [PATCH 21/27] Documentation: x86: convert x86_64/boot-options.txt " Changbin Du
2019-04-27 18:30 ` Mauro Carvalho Chehab
2019-05-02 5:49 ` Changbin Du
2019-04-26 15:31 ` [PATCH 22/27] Documentation: x86: convert x86_64/uefi.txt " Changbin Du
2019-04-27 18:31 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 23/27] Documentation: x86: convert x86_64/mm.txt " Changbin Du
2019-04-27 18:35 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 24/27] Documentation: x86: convert x86_64/5level-paging.txt " Changbin Du
2019-04-27 18:36 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 25/27] Documentation: x86: convert x86_64/fake-numa-for-cpusets " Changbin Du
2019-04-27 18:38 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 26/27] Documentation: x86: convert x86_64/cpu-hotplug-spec " Changbin Du
2019-04-27 18:40 ` Mauro Carvalho Chehab
2019-04-26 15:31 ` [PATCH 27/27] Documentation: x86: convert x86_64/machinecheck " Changbin Du
2019-04-27 18:42 ` Mauro Carvalho Chehab
2019-04-26 15:39 ` [PATCH 00/27] Include linux x86 docs into Sphinx TOC tree Mauro Carvalho Chehab
2019-04-27 2:47 ` Changbin Du
2019-04-27 9:54 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20190427141952.4727075e@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=bp@alien8.de \
--cc=changbin.du@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=tglx@linutronix.de \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).