Re: [PULL] Copyedit: Documentation/x86/boot.txt

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Pull from:

  git://github.com/mfwitten/linux-2.6.git trivial/docs/boot

To get the updated commits (see the incremental diff below):

  Documentation/x86/boot.txt |  398 ++++++++++++++++++++++---------------------
  1 files changed, 204 insertions(+), 194 deletions(-)

  [00] Docs: boot.txt: `syssize' -> `sys_size'
  [01] Docs: boot.txt: Consistently use 2 spaces between sentences
  [02] Docs: boot.txt: Use the subjunctive mood
  [03] Docs: boot.txt: Clean up sentences
  [04] Docs: boot.txt: Add parentheses and a comma to improve flow
  [05] Docs: boot.txt: Remove bizarrely embedded tabs
  [06] Docs: boot.txt: Make protocol version descriptions consistent.
  [07] Docs: boot.txt: Remove commas
  [08] Docs: boot.txt: Use present tense
  [09] Docs: boot.txt: Remove awkward infinitive
  [10] Docs: boot.txt: Add periods to have consistent diagrams
  [11] Docs: boot.txt: Move definition of `X' upwards
  [12] Docs: boot.txt: Better heap_end_ptr description
  [13] Docs: boot.txt: Clarify the meaning of a 0 value for setup_sects
  [14] Docs: boot.txt: Streamline introduction of `read' and `write' fields
  [15] Docs: boot.txt: Put `(obligatory)' in double quotes
  [16] Docs: boot.txt: `who' is reserved for humans; `that' should be used.
  [17] Docs: boot.txt: Put `(reloc)' in double quotes
  [18] Docs: boot.txt: `can' -> `may'
  [19] Docs: boot.txt: `littleendian' -> `little-endian'
  [20] Docs: boot.txt: Offset each modifier with a comma
  [21] Docs: boot.txt: `device device' is a little silly
  [22] Docs: boot.txt: Move period outside of parentheses
  [23] Docs: boot.txt: Add a subject to make a full sentence
  [24] Docs: boot.txt: `id' -> `ID'
  [25] Docs: boot.txt: Clarify code32_start description
  [26] Docs: boot.txt: `;' -> `,'
  [27] Docs: boot.txt: `uncompress' -> `decompress'
  [28] Docs: boot.txt: Remove superfluous `linear'
  [29] Docs: boot.txt: Add `;' to end of pseudo-code lines
  [30] Docs: boot.txt: Streamline discussion of the kernel command line
  [31] Docs: boot.txt: Streamline the real-mode allocation requirement
  [32] Docs: boot.txt: Use ISO units and consistent language
  [33] Docs: boot.txt: Use `neither...nor...'
  [34] Docs: boot.txt: Use `[Rr]eal-mode' consistently
  [35] Docs: boot.txt: Clean up discussion of the 32-bit protocol
  [36] Docs: boot.txt: `NUL-terminated' -> `null-terminated'

diff --git a/Documentation/x86/boot.txt b/Documentation/x86/boot.txt
index 7696e20..e9c32bb 100644
--- a/Documentation/x86/boot.txt
+++ b/Documentation/x86/boot.txt
@@ -151,7 +151,7 @@ Offset	Proto	Name		Meaning
 
 01F1/1	ALL(1	setup_sects	The size of the setup in sectors
 01F2/2	ALL	root_flags	If set, the root is mounted readonly
-01F4/4	2.04+(2	sys_size	The size of the 32-bit code
+01F4/4	2.04+(2	sys_size	The size (in 16B paragraphs) of the 32-bit code
 01F8/2	ALL	ram_size	DO NOT USE - for bootsect.S use only
 01FA/2	ALL	vid_mode	Video mode control
 01FC/2	ALL	root_dev	Default root device number
@@ -326,7 +326,7 @@ Type:		read
 Offset/size:	0x20e/2
 Protocol:	2.00+
 
-  If set to a nonzero value, it contains a pointer to a NUL-terminated
+  If set to a nonzero value, it contains a pointer to a null-terminated
   human-readable kernel version number string, less 0x200.  This can
   be used to display the kernel version to the user.  This value
   should be less than (0x200*setup_sects).
@@ -637,9 +637,10 @@ Type:		write (special)
 Offset/size:	0x250/8
 Protocol:	2.09+
 
-  A 64-bit physical pointer to point to a NULL-terminated singly-linked list of
-  struct setup_data.  This is used to define a more extensible mechanism for
-  passing boot parameters.  The definition of struct setup_data is as follows:
+  A 64-bit physical pointer to point to a NULL-terminated, intrusive,
+  singly-linked list whose nodes are of type "struct setup_data".
+  This is used to define a more extensible mechanism for passing boot
+  parameters.  The definition of struct setup_data is as follows:
 
   struct setup_data {
 	  u64 next;
@@ -842,9 +843,10 @@ Such a boot loader should enter the following fields in the header:
 
 **** LOADING THE REST OF THE KERNEL
 
-The protected-mode kernel starts at offset "(setup_sects+1)*512"
-in the kernel file (again, if (setup_sects == 0) { setup_sects = 4; }).
-It should be loaded at address 0x10000 for Image/zImage kernels and at
+In the kernel file, the protected-mode code starts at offset
+"(setup_sects+1)*512" (or 0xa00 if setup_sects is 0, because
+setup_sects is treated as though it were 4); the code should
+be loaded at address 0x10000 for Image/zImage kernels and at
 0x100000 for bzImage kernels.
 
 The kernel is a bzImage kernel if the protocol >= 2.00 and the 0x01
-- 
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux