[ros-diffs] [reactos] 09/10: [FREELDR] Update existing FREELDR.INI documentation.

[Hermès Bélusca-Maïto]

https://git.reactos.org/?p=reactos.git;a=commitdiff;h=63833c769f4844f300b5b…

commit 63833c769f4844f300b5be69fa8e28b406eec7c3
Author:     Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org>
AuthorDate: Sun Feb 20 20:56:33 2022 +0100
Commit:     Hermès Bélusca-Maïto <hermes.belusca-maito(a)reactos.org>
CommitDate: Mon Feb 21 02:54:05 2022 +0100

    [FREELDR] Update existing FREELDR.INI documentation.
---
 boot/freeldr/FREELDR.INI | 88 ++++++++++++++++++++++++------------------------
 1 file changed, 44 insertions(+), 44 deletions(-)

diff --git a/boot/freeldr/FREELDR.INI b/boot/freeldr/FREELDR.INI
index 48561fc4475..ddb9a88277d 100644
--- a/boot/freeldr/FREELDR.INI
+++ b/boot/freeldr/FREELDR.INI
@@ -11,14 +11,14 @@
 ;
 ; Debug         - FreeLoader debugging port parameters, e.g.
 ;                 /DEBUG /DEBUGPORT=COM1 /BAUDRATE=115200
-; MessageBox    - displays the specified text in a message box upon bootup.
-; DefaultOS     - specifies which OS listed is the default choice.
-; TimeOut       - sets the timeout (in seconds) before the first OS listed
+; MessageBox    - Displays the specified text in a message box upon startup.
+; DefaultOS     - Specifies which OS listed is the default choice.
+; TimeOut       - Sets the timeout (in seconds) before the first OS listed
 ;                 gets booted automatically.
 
 ; [Display] Section Commands:
 ;
-; DisplayMode           - sets the video mode to be used by FreeLoader.
+; DisplayMode           - Sets the video mode to be used by FreeLoader.
 ;                         The following values are supported:
 ;                         NORMAL_VGA for 80x25
 ;                         EXTENDED_VGA for 80x50 on VGA 80x43 on EGA
@@ -28,22 +28,22 @@
 ;                         0x502B for 80x43
 ;                         0x503C for 80x60
 ;
-; TitleText             - text that is displayed in the title box.
-; StatusBarColor        - color of status bar's background.
-; StatusBarTextColor    - color of status bar's text.
-; BackdropTextColor     - color of the backdrop's fill.
-; BackdropColor         - color of the backdrop's background.
-; BackdropFillStyle     - backdrop fill style - can be: Light, Medium, Dark.
-; TitleBoxTextColor     - title box text color.
-; TitleBoxColor         - title box background color.
-; MessageBoxTextColor   - message box text color.
-; MessageBoxColor       - message box background color.
-; MenuTextColor         - menu text color.
-; MenuColor             - menu color.
-; TextColor             - normal text color.
-; SelectedTextColor     - selected text color.
-; SelectedColor         - selected text background color.
-; SpecialEffects        - turns on ("Yes") or off ("No") video
special effects.
+; TitleText             - Text that is displayed in the title box.
+; StatusBarColor        - Color of status bar's background.
+; StatusBarTextColor    - Color of status bar's text.
+; BackdropTextColor     - Color of the backdrop's fill.
+; BackdropColor         - Color of the backdrop's background.
+; BackdropFillStyle     - Backdrop fill style - can be: Light, Medium, Dark.
+; TitleBoxTextColor     - Title box text color.
+; TitleBoxColor         - Title box background color.
+; MessageBoxTextColor   - Message box text color.
+; MessageBoxColor       - Message box background color.
+; MenuTextColor         - Menu text color.
+; MenuColor             - Menu color.
+; TextColor             - Normal text color.
+; SelectedTextColor     - Selected text color.
+; SelectedColor         - Selected text background color.
+; SpecialEffects        - Turns on ("Yes") or off ("No") video
special effects.
 ;
 ; Background colors can be any one of the following:
 ; Black, Blue, Green, Cyan, Red, Magenta, Brown, Gray.
@@ -57,31 +57,31 @@
 
 ; [OS-General] Section Commands:
 ;
-; BootType  - specifies the boot type: Windows, WindowsNT40, Windows2003,
+; BootType  - Specifies the boot type: Windows, WindowsNT40, Windows2003,
 ;             ReactOSSetup, Linux, BootSector, Partition, Drive
 ; BootPath  - ARC path, e.g. multi(0)disk(0)rdisk(x)partition(y)
-; DriveMap  - maps a BIOS drive number to another (i.e. DriveMap=hd1,hd0
-;             maps harddisk1 to harddisk0 or DriveMap=fd1,fd0).
+; DriveMap  - Maps a BIOS drive number to another (i.e. DriveMap=hd1,hd0
+;             maps harddisk1 to harddisk0; or DriveMap=fd1,fd0).
 
 ; ["Drive" OSType] Section Commands:
 ;
-; BootDrive - specifies the BIOS drive number to be used.
+; BootDrive - BIOS drive number to be used.
 ;
 ; REMARK: If a "BootPath" ARC path is specified, its value takes precedence
 ; over the "BootDrive" value.
 
 ; ["Partition" OSType] Section Commands:
 ;
-; BootDrive     - specifies the BIOS drive number to be used.
-; BootPartition - specifies the partition number to be used (default: 0).
+; BootDrive     - BIOS drive number to be used.
+; BootPartition - Partition number to be used (default: 0).
 ;
 ; REMARK: If a "BootPath" ARC path is specified, its value takes precedence
 ; over both the "BootDrive" and "BootPartition" values.
 
 ; ["BootSector" OSType] Section Commands:
 ;
-; BootDrive      - specifies the BIOS drive number to be used.
-; BootPartition  - specifies the partition number to be used (cannot be 0).
+; BootDrive      - BIOS drive number to be used.
+; BootPartition  - Partition number to be used (cannot be 0).
 ;
 ; REMARK: If a "BootPath" ARC path is specified, its value takes precedence
 ; over both the "BootDrive" and "BootPartition" values.
@@ -90,7 +90,7 @@
 ; If none of them are given and a relative file path is specified by the
 ; "BootSectorFile" value, the default boot partition will be used instead.
 ;
-; BootSectorFile - specifies the file name of the bootsector to be loaded.
+; BootSectorFile - File name of the bootsector to be loaded.
 ;                  It can be either relative to "BootDrive" and
"BootPartition"
 ;                  (or to "BootPath"), or be an absolute ARC path, in which
case
 ;                  the "BootDrive" and "BootPartition" (or
"BootPath") values
@@ -98,8 +98,8 @@
 
 ; ["Linux" OSType] Section Commands:
 ;
-; BootDrive     - specifies the BIOS drive number to be used.
-; BootPartition - specifies the partition number to be used (cannot be 0).
+; BootDrive     - BIOS drive number to be used.
+; BootPartition - Partition number to be used (cannot be 0).
 ;
 ; REMARK: If a "BootPath" ARC path is specified, its value takes precedence
 ; over both the "BootDrive" and "BootPartition" values.
@@ -108,37 +108,37 @@
 ; If none of them are given and a relative file path is specified by the
 ; "Kernel" or "Initrd" values, the default boot partition will be
used instead.
 ;
-; Kernel        - specifies the kernel file name to be used.
+; Kernel        - Kernel file name to be used.
 ;                 It can be either relative to "BootDrive" and
"BootPartition"
 ;                 (or to "BootPath"), or be an absolute ARC path, in which
case
 ;                 the "BootDrive" and "BootPartition" (or
"BootPath") values
 ;                 will only be used to set the boot partition.
-; Initrd        - specifies the optional init ramdisk file name to be used.
-;                 The same remarks about the path as for "Kernel" remain
valid.
-; CommandLine   - specifies the boot load options for the kernel.
+; Initrd        - Optional init ramdisk file name to be used.
+;                 The same remarks about the path for "Kernel" also apply
here.
+; CommandLine   - Boot load options for the kernel.
 
 ; ["Windows(NT40|2003)" OSType] Section Commands:
 ;
-; SystemPath    - specifies the system root path (must be a valid ARC path):
+; SystemPath    - System root path (must be a valid ARC path), e.g.
 ;                 multi(0)disk(0)rdisk(0)partition(1)\reactos
 ;                 multi(0)disk(0)fdisk(0)
-; Options       - specifies the boot load options for the kernel.
-; Kernel        - specifies the kernel file name (default: ntoskrnl.exe)
-; Hal           - specifies the HAL file name (default: hal.dll)
+; Options       - Boot load options for the kernel.
+; Kernel        - Kernel file name (default: ntoskrnl.exe)
+; Hal           - HAL file name (default: hal.dll)
 ;
 ; REMARK: The "Kernel" and "Hal" values can be either relative to
"SystemPath",
-; or be an absolute ARC path. Also they can alternatively be specified using the
-; NT-compatible "/HAL=filename" and "/KERNEL=filename" option
switches to the
-; "Options" value, in which case the latter ones take precedence.
+; or be an absolute ARC path. Also they can alternatively be specified using
+; the NT-compatible "/HAL=filename" and "/KERNEL=filename" option
switches to
+; the "Options" value, in which case the latter ones take precedence.
 
 ; ["ReactOSSetup" OSType] Section Commands:
 ;
 ; This OS type is used to start the SETUP portion of NT / ReactOS.
 ;
-; SystemPath    - specifies the system root path (must be a valid ARC path):
+; SystemPath    - System root path (must be a valid ARC path), e.g.
 ;                 multi(0)disk(0)rdisk(0)partition(1)\reactos
 ;                 multi(0)disk(0)fdisk(0)
-; Options       - specifies extra boot load options for the kernel and the
+; Options       - Extra boot load options for the kernel and the
 ;                 setup environment (see REMARK 2 below).
 ;
 ; REMARK: Contrary to the "Windows" type, this OS type does not support
separate