FS#6146. Corrections to description of bootloaders on targets which store the Rockbox bootloader on disk.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@11175 a1c6a512-1295-4272-9138-f99709370657

12 files changed, 37 insertions, 6 deletions

diff --git a/manual/getting_started/installation.tex b/manual/getting_started/installation.tex
index d29d56dd81..49091c304c 100644
--- a/manual/getting_started/installation.tex
+++ b/manual/getting_started/installation.tex
@@ -67,21 +67,41 @@ software.
 \opt{SWCODEC}{
   \subsection{Introduction}
   
-  There are two separate components of Rockbox that need to be installed in 
-  order to run Rockbox.
+  \opt{HAVE_FIRMWARE_ON_DISK}{There are three separate components of Rockbox, 
+  two of which need to be installed in order to run Rockbox.}
+  
+  \opt{HAVE_FIRMWARE_IN_FLASH}{There are two separate components of Rockbox 
+  that need to be installed in order to run Rockbox.}
   
   \begin{description}
+  \opt{HAVE_FIRMWARE_ON_DISK}{    
+  \item[The \playerman{} bootloader]
+    The \playerman{} bootloader is the program that tells your \dap{} how to boot 
+    and load the remaining firmware from disk. It is also responsible for the
+    disk mode on your \dap{}.
+    
+    This bootloader is stored in special flash memory in your \playerman. It is 
+    already installed on your \dap{}, so it is never necessary to modify this 
+    in order to install Rockbox.}
     
   \item[The Rockbox bootloader.] \index{Bootloader}
+    \opt{HAVE_FIRMWARE_ON_DISK}{The Rockbox bootloader is loaded from disk by 
+    the \playerman{} bootloader. It is responsible for loading the Rockbox 
+    firmware and for providing the dual boot function. It directly replaces the
+    \playerman{} firmware on the \daps{} disk.}
+    \opt{HAVE_FIRMWARE_IN_FLASH}{
     The bootloader is the program that tells your 
     \dap{} how to boot and load other components of Rockbox. This is the 
     component of Rockbox that is installed to the flash memory of your 
-    \playerman. 
+    \playerman.}
   
-  \item[The Rockbox firmware.] Unlike the \playerman\ firmware, which runs 
-    entirely from flash memory, most of the Rockbox code is contained in a 
+  \item[The Rockbox firmware.] 
+    \opt{HAVE_FIRMWARE_IN_FLASH}{Unlike the \playerman{} firmware, which runs 
+    entirely from flash memory, }
+    \opt{HAVE_FIRMWARE_ON_DISK}{Similar to the \playerman{} firmware, }
+    most of the Rockbox code is contained in a 
     ``build'' that resides on your \daps{} hard drive. This makes it easy to 
-    update Rockbox. The build consists of a file named \firmwarefilename\ and a
+    update Rockbox. The build consists of a file named \firmwarefilename{} and a
     directory called \fname{.rockbox}, both of which are located in the root 
     directory of your hard drive.
     
diff --git a/manual/platform/h10.tex b/manual/platform/h10.tex
index 08e954d773..8faef39d88 100644
--- a/manual/platform/h10.tex
+++ b/manual/platform/h10.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{h10}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
 \edef\UseOption{\UseOption,CONFIG_RTC}
diff --git a/manual/platform/h10_5gb.tex b/manual/platform/h10_5gb.tex
index dad0ca1f70..3f4d46833e 100644
--- a/manual/platform/h10_5gb.tex
+++ b/manual/platform/h10_5gb.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{h10_5gb}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,HAVE_LCD_COLOR}
 \edef\UseOption{\UseOption,CONFIG_RTC}
diff --git a/manual/platform/h1xx.tex b/manual/platform/h1xx.tex
index c25ac063e9..de3623a305 100644
--- a/manual/platform/h1xx.tex
+++ b/manual/platform/h1xx.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{h1xx}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
diff --git a/manual/platform/h300.tex b/manual/platform/h300.tex
index eade9d8f76..4b71ef240c 100644
--- a/manual/platform/h300.tex
+++ b/manual/platform/h300.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{h300}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}
diff --git a/manual/platform/ipod3g.tex b/manual/platform/ipod3g.tex
index 836ac697cc..31c9e3852a 100644
--- a/manual/platform/ipod3g.tex
+++ b/manual/platform/ipod3g.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipod3g}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/ipod4g.tex b/manual/platform/ipod4g.tex
index 69309f623d..9285a5d5db 100644
--- a/manual/platform/ipod4g.tex
+++ b/manual/platform/ipod4g.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipod4g}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/ipodcolor.tex b/manual/platform/ipodcolor.tex
index 100e2b7d61..6bdb4d5855 100644
--- a/manual/platform/ipodcolor.tex
+++ b/manual/platform/ipodcolor.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipodcolor}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/ipodmini.tex b/manual/platform/ipodmini.tex
index b28ef3a70d..b3df423998 100644
--- a/manual/platform/ipodmini.tex
+++ b/manual/platform/ipodmini.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipodmini}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/ipodnano.tex b/manual/platform/ipodnano.tex
index f0111bcaa3..d7518d1592 100644
--- a/manual/platform/ipodnano.tex
+++ b/manual/platform/ipodnano.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipodnano}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/ipodvideo.tex b/manual/platform/ipodvideo.tex
index 3d9a4f9c6b..3d7aec2b7e 100644
--- a/manual/platform/ipodvideo.tex
+++ b/manual/platform/ipodvideo.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{ipodvideo}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_ON_DISK}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,CONFIG_RTC}
 \edef\UseOption{\UseOption,SWCODEC}
diff --git a/manual/platform/x5.tex b/manual/platform/x5.tex
index 42f9d17229..fb70a23336 100644
--- a/manual/platform/x5.tex
+++ b/manual/platform/x5.tex
@@ -1,5 +1,6 @@
 % $Id$ %
 \def\UseOption{x5}
+\edef\UseOption{\UseOption,HAVE_FIRMWARE_IN_FLASH}
 \edef\UseOption{\UseOption,HAVE_LCD_BITMAP}
 \edef\UseOption{\UseOption,HAVE_RECORDING}
 \edef\UseOption{\UseOption,CONFIG_TUNER}