From 01f8f62b5579627edc17727420f8cc1656a461d4 Mon Sep 17 00:00:00 2001
From: Volker Ruppert <Volker.Ruppert@t-online.de>
Date: Sun, 20 Feb 2011 09:35:48 +0000
Subject: [PATCH] - next step of documentation updates for release 2.4.6

---
 bochs/doc/docbook/development/development.dbk | 21 ++++++++++++-------
 bochs/doc/man/bochsrc.5                       | 10 ++++++++-
 bochs/iodev/devices.txt                       | 17 ++++++++++-----
 3 files changed, 34 insertions(+), 14 deletions(-)

diff --git a/bochs/doc/docbook/development/development.dbk b/bochs/doc/docbook/development/development.dbk
index a83056061..011b0cc13 100644
--- a/bochs/doc/docbook/development/development.dbk
+++ b/bochs/doc/docbook/development/development.dbk
@@ -1,7 +1,7 @@
 <!--
 ================================================================
 doc/docbook/development/development.dbk
-$Id: development.dbk,v 1.37 2011-01-25 23:29:08 vruppert Exp $
+$Id: development.dbk,v 1.38 2011-02-20 09:35:47 vruppert Exp $
 
 This is the top level file for the Bochs Developers Manual.
 ================================================================
@@ -1379,7 +1379,8 @@ the future.
 <section id="harddisk-redologs"><title>Harddisk Images based on redologs</title>
 <para>
 This section describes how the three new disk images "undoable", "growing", and "volatile" are
-implemented in Bochs 2.1 :
+implemented in Bochs 2.1. It also applies to the write support the "vvfat" disk
+image mode in Bochs 2.4.6.
 </para>
 <itemizedlist>
 <listitem><para>
@@ -1391,6 +1392,9 @@ growing  -> growing files, all previously unwritten sectors go to the end of fil
 <listitem><para>
 volatile -> flat file, plus hidden growing redolog
 </para></listitem>
+<listitem><para>
+vvfat -> virtual VFAT disk created from directory, plus hidden growing redolog
+</para></listitem>
 </itemizedlist>
 
 <para>
@@ -1403,10 +1407,11 @@ volatile -> flat file, plus hidden growing redolog
 <para>
 The idea behind volatile and undoable disk images
 is to have a flat file, associated with one redolog file.
+In case of vvfat, a directory is associated with the redolog file.
 </para>
 <para>
 Reading a sector is done from the redolog file if it contains
-the sector, or from the flat file otherwise.
+the sector, or from the flat file / vvfat directory otherwise.
 </para>
 <para>
 Sectors written go to the redolog,
@@ -1425,7 +1430,7 @@ Now, it turns out that if you only use a redolog without any
 flat file, you get a "growing" disk image.
 </para>
 <para>
-So "undoable", "volatile" and "growing" harddisk images classes
+So "undoable", "volatile", "growing" and "vvfat" harddisk images classes
 are implemented on top of a redolog class.
 </para>
 </section>
@@ -2408,7 +2413,7 @@ new release is ready for download.
 
 <section id="project-webspace"><title>Bochs project webspace</title>
 <para>
-The Bochs project webspace is stored under the SF directory <filename>/home/groups/b/bo/bochs</filename>.
+The Bochs project webspace is stored under the SF directory <filename>/home/project-web/bochs</filename>.
 It can be accessed from the SF shell using SSH or with the commands <command>sftp</command>,
 <command>scp</command> and <command>rsync</command>. Some parts of the directory
 structure must be updated from the local CVS repository, others from Bochs CVS
@@ -2468,7 +2473,7 @@ Use the "timeleft" command to see how much time remains before shutdown.
 Use the "shutdown" command to destroy the shell before the time limit.
 For path information and login help, type "sf-help".
 
-[vruppert@shell-24002 ~]$ cd /home/groups/b/bo/bochs/htdocs/
+[vruppert@shell-24002 ~]$ cd /home/project-web/bochs/htdocs/
 [vruppert@shell-24002 htdocs]$ cvs update
 cvs update: Updating .
 U index.html
@@ -2503,7 +2508,7 @@ called <command>update-snapshots.sh</command> that can do all the required steps
 (checking out CVS, packing the source tree into one archive, updating the website
 link). See previous section how to create a shell.
 <screen>
-cd /home/groups/b/bo/bochs/sitebin/
+cd /home/project-web/bochs/sitebin/
 ./update-snapshots.sh
 </screen>
 </para>
@@ -2523,7 +2528,7 @@ After a successful upload, the HTML files must be unpacked from the SF shell.
 See section <link linkend="update-website">Updating the Bochs website content</link>
 how to create a shell.
 <screen>
-cd /home/groups/b/bo/bochs/htdocs/doc/docbook
+cd /home/project-web/bochs/htdocs/doc/docbook
 tar xvzf bochsdoc.tar.gz
 </screen>
 The updated files can be accessed from the sidebar of the Bochs website.
diff --git a/bochs/doc/man/bochsrc.5 b/bochs/doc/man/bochsrc.5
index 49d50c4b6..36fee8093 100644
--- a/bochs/doc/man/bochsrc.5
+++ b/bochs/doc/man/bochsrc.5
@@ -1,5 +1,5 @@
 .\"Document Author:  Timothy R. Butler   -   tbutler@uninetsolutions.com"
-.TH bochsrc 5 "5 Jan 2011" "bochsrc" "The Bochs Project"
+.TH bochsrc 5 "20 Feb 2011" "bochsrc" "The Bochs Project"
 .\"SKIP_SECTION"
 .SH NAME
 bochsrc \- Configuration file for Bochs.
@@ -347,6 +347,9 @@ Example:
 Autodetect floppy media type:
   floppya: image=path, status=inserted
 
+Use directory as 1.44M VFAT media:
+  floppya: 1_44=vvfat:path, status=inserted
+
 1.44M 3.5" floppy drive, no media:
   floppya: type=1_44
 
@@ -930,6 +933,11 @@ of the i440FX PCI chipset. With the portX option you can connect devices
 to the hub (currently supported: 'mouse', 'tablet', 'keypad', 'disk', 'cdrom',
 'hub' and 'printer').
 
+The optionsX parameter can be used to assign specific options to the device
+connected to the corresponding USB port. Currently this feature is only used
+to set the speed reported by device and by the 'disk' device to specify
+an alternative redolog file of some image modes.
+
 If you connect the mouse or tablet to one of the ports, Bochs forwards the
 mouse movement data to the USB device instead of the selected mouse type.
 When connecting the keypad to one of the ports, Bochs forwards the input of
diff --git a/bochs/iodev/devices.txt b/bochs/iodev/devices.txt
index 88eae24a5..4e1e1756b 100755
--- a/bochs/iodev/devices.txt
+++ b/bochs/iodev/devices.txt
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////
-// $Id: devices.txt,v 1.4 2009-12-04 13:21:33 sshwarts Exp $
+// $Id: devices.txt,v 1.5 2011-02-20 09:35:48 vruppert Exp $
 /////////////////////////////////////////////////////////////////////////
 
 MOTHER BOARD (i440FX Support)                                   devices.cc
@@ -24,7 +24,7 @@ MOTHER BOARD (i440FX Support)                                   devices.cc
   |        |             +---- PC Speaker (lowlevel)            speaker.cc
   |
   |        +---- 8237 DMA controller                            dma.cc
-  |        +---- 82077A Floppy Drive Controller                 floppy.cc
+  |        +---- 82077A Floppy Drive Controller (*)             floppy.cc
   |        +---- CMOS device                                    cmos.cc
   |        +---- External circuit for #FERR pin                 extfpuirq.cc
   |        +---- Parallel ports emulation                       parallel.cc
@@ -44,7 +44,9 @@ Attached devices
   |
   +---- Hard Drive + ATA controller                             harddrv.cc
   |        |
-  |        +---- Hard Drive image support (*)                   hdimage.cc, vmware3.cc, vmware4.cc
+  |        +---- Hard Drive image support (*)                   hdimage.cc
+  |        |             |
+  |        |             +---- Additional Modules               vmware3.cc, vmware4.cc, vvfat.cc
   |        |
   |        +---- CD/DVD-ROM image / device access (*)           cdrom.cc
   |                      |
@@ -75,6 +77,8 @@ Attached devices
   +---- Sound support
   |        |
   |        +---- Sound Blaster SB16                             sb16.cc
+  |                      | |
+  |                      | +-- Dummy / Control Module           soundmod.cc
   |                      |
   |                      +---- Host specific Modules            soundlnx.cc, soundosx.cc, soundwin.cc
   |
@@ -85,14 +89,17 @@ Attached devices
            |             +---- USB OHCI adapter                 usb_ohci.cc
            |             +---- USB UHCI adapter (PIIX3)         usb_uhci.cc
            |
-           +---- Attached USB devices                           usb_common.cc
+           +---- Attached USB devices
+                         | |
+                         | +-- Control Module                   usb_common.cc
                          |
                          +---- USB HID emulation                usb_hid.cc
                          +---- USB external HUB                 usb_hub.cc
                          +---- USB mass storage device (*)      usb_msd.cc, scsi_device.cc
                          +---- USB HP DeskJet 920C printer      usb_printer.cc
 
-(*) USB MSD uses hdimage.cc and cdrom.cc for image / device access
+(*) USB MSD uses hdimage code and cdrom.cc for image / device access
+    Floppy uses hdimage code for VVFAT support
 
 BOCHS timer sycronisation modules
   |