Add installation notes to source files.

I added comments to all patch files explaining their function and how to install them. Installation instructions were also added to some of the code files as well.

15 files changed, 63 insertions, 7 deletions

diff --git a/Adam/Patches/Mount2CaseAFDC.HC b/Adam/Patches/Mount2CaseAFDC.HC
index a3b307b..8b76184 100644
--- a/Adam/Patches/Mount2CaseAFDC.HC
+++ b/Adam/Patches/Mount2CaseAFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add the ability to configure floppy BlkDevs (part 1 of 2)
+// FILE: ::/Adam/ABlkDev/Mount.HC
+// TO INSTALL: #include this file at the end of the first switch statement.
+
 case BDT_FLOPPY:
   do {
     "Include $PURPLE$0x$FG$ prefix.\nI/O Port Base:\n";
diff --git a/Adam/Patches/Mount2CaseBFDC.HC b/Adam/Patches/Mount2CaseBFDC.HC
index b661bad..372ff7e 100644
--- a/Adam/Patches/Mount2CaseBFDC.HC
+++ b/Adam/Patches/Mount2CaseBFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add the ability to configure floppy BlkDevs (part 2 of 2)
+// FILE: ::/Adam/ABlkDev/Mount.HC
+// TO INSTALL: #include this file at the end of the second switch statement.
+
 case BDT_FLOPPY:
   if (defaults) {
     // These assume a 1.44 Meg, 3.5-inch floppy
diff --git a/Adam/Patches/Mount2LtrsFDC.HC b/Adam/Patches/Mount2LtrsFDC.HC
index e196eb8..b55fa3f 100644
--- a/Adam/Patches/Mount2LtrsFDC.HC
+++ b/Adam/Patches/Mount2LtrsFDC.HC
@@ -1,8 +1,12 @@
+// PATCH: Update ltr lst to reflect remapping of drv ltrs
+// FILE: ::/Adam/ABlkDev/Mount.HC
+// TO INSTALL: Comment out the original Print call, then #include this file.
+
 "\n****** Mount Drives ******\n"
-      "$GREEN$A$FG$-$GREEN$B$FG$ are RAM drives.\n"
-      "$GREEN$C$FG$-$GREEN$L$FG$ are ATA hard drives.\n"
-      "$GREEN$M$FG$-$GREEN$P$FG$ are ISO file read drives.\n"
-      "$GREEN$Q$FG$-$GREEN$S$FG$ are ISO file write drives.\n"
-      "$GREEN$T$FG$-$GREEN$V$FG$ are ATAPI CD/DVD drives.\n"
-      "$GREEN$W$FG$-$GREEN$Z$FG$ are floppy drives.\n"
-      "\nDrive Letter ($PURPLE$<ENTER>$FG$ to exit):";
\ No newline at end of file
+  "$GREEN$A$FG$-$GREEN$B$FG$ are RAM drives.\n"
+  "$GREEN$C$FG$-$GREEN$L$FG$ are ATA hard drives.\n"
+  "$GREEN$M$FG$-$GREEN$P$FG$ are ISO file read drives.\n"
+  "$GREEN$Q$FG$-$GREEN$S$FG$ are ISO file write drives.\n"
+  "$GREEN$T$FG$-$GREEN$V$FG$ are ATAPI CD/DVD drives.\n"
+  "$GREEN$W$FG$-$GREEN$Z$FG$ are floppy drives.\n"
+  "\nDrive Letter ($PURPLE$<ENTER>$FG$ to exit):";
\ No newline at end of file
diff --git a/Adam/Patches/Mount2VarsFDC.HC b/Adam/Patches/Mount2VarsFDC.HC
index 3213946..c164a14 100644
--- a/Adam/Patches/Mount2VarsFDC.HC
+++ b/Adam/Patches/Mount2VarsFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add more U8 bufs for floppy configuration
+// FILE: ::/Adam/ABlkDev/Mount.HC
+// TO INSTALL: Comment out the original declaration, then #include this file.
+
 U8 blks_buf[STR_LEN],addr_buf[STR_LEN],base0_buf[STR_LEN],base1_buf[STR_LEN],
 	cyl_buf[STR_LEN],heads,spt_buf[STR_LEN],size,srt_buf[STR_LEN],
 	hut_buf[STR_LEN],hlt_buf[STR_LEN],bps,gpl1_buf[STR_LEN],
diff --git a/Adam/Patches/Mount2VarsFDC2.HC b/Adam/Patches/Mount2VarsFDC2.HC
index 5037f2b..41871e5 100644
--- a/Adam/Patches/Mount2VarsFDC2.HC
+++ b/Adam/Patches/Mount2VarsFDC2.HC
@@ -1 +1,5 @@
+// PATCH: Add two new Bools for floppy configuration
+// FILE: ::/Adam/ABlkDev/Mount.HC
+// TO INSTALL: Comment out the old Bool declaration, then #include this file.
+
 Bool whole_drv,make_free,defaults=FALSE;
\ No newline at end of file
diff --git a/Kernel/BlkDev/DskFDC.HC b/Kernel/BlkDev/DskFDC.HC
index 80856b5..4012627 100644
--- a/Kernel/BlkDev/DskFDC.HC
+++ b/Kernel/BlkDev/DskFDC.HC
@@ -4,6 +4,8 @@
     License. See the Copying.TXT file for details.
 */
 
+// TO INSTALL: #include this file after DskATA in MakeBlkDev.HC.
+
 interrupt U0 FDCInt()
 {
   // On IRQ6, set a semaphore for anything waiting for an FDC int
diff --git a/Kernel/KFloppyA.HH b/Kernel/KFloppyA.HH
index 7d0fe4d..63e7b80 100644
--- a/Kernel/KFloppyA.HH
+++ b/Kernel/KFloppyA.HH
@@ -4,6 +4,9 @@
     License. See the Copying.TXT file for details.
 */
 
+// TO INSTALL: #include this file in Kernel.PRJ, before MakeBlkDev is #included.
+// Also #include it in ::/StartOS.HC.
+
 // FDC uses IRQ6 = int 26h
 #define I_FDC	0x26
 #define IRQ_FDC	6
diff --git a/Kernel/KFloppyB2.HH b/Kernel/KFloppyB2.HH
index 09e5326..0af3047 100644
--- a/Kernel/KFloppyB2.HH
+++ b/Kernel/KFloppyB2.HH
@@ -4,6 +4,9 @@
     License. See the Copying.TXT file for details.
 */
 
+// TO INSTALL: #include this file after KernelA.HH in Kernel.PRJ.
+// Also #include it in StartOS.HC.
+
 public extern U0 FDCDMAInit(U16 len);
 public extern U0 FDCDMAPrepWrite();
 public extern U0 FDCDMAPrepRead();
diff --git a/Kernel/Patches/BlkDevAddFDC.HC b/Kernel/Patches/BlkDevAddFDC.HC
index 3a9d749..1f9e75a 100644
--- a/Kernel/Patches/BlkDevAddFDC.HC
+++ b/Kernel/Patches/BlkDevAddFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add the ability to create floppy drvs
+// FILE: ::/Kernel/BlkDev/DskAddDev.HC
+// TO INSTALL: #include this file at the end of the switch statement.
+
 case BDT_FLOPPY:
   dv->dv_signature=DRV_SIGNATURE_VAL;
   if (!BlkDevInit(bd))
diff --git a/Kernel/Patches/BlkDevInitFDC.HC b/Kernel/Patches/BlkDevInitFDC.HC
index 3fbe709..630bad8 100644
--- a/Kernel/Patches/BlkDevInitFDC.HC
+++ b/Kernel/Patches/BlkDevInitFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add the ability to init floppy BlkDevs
+// FILE: ::/Kernel/BlkDev/DskBlkDev.HC
+// TO INSTALL: #include this file at the end of the switch statement.
+
 case BDT_FLOPPY:
   bd->max_writes=bd->max_reads=bd->spt;
   res=FDCInit(bd);
diff --git a/Kernel/Patches/CBlkDevFDC.HC b/Kernel/Patches/CBlkDevFDC.HC
index d7115f3..82c167c 100644
--- a/Kernel/Patches/CBlkDevFDC.HC
+++ b/Kernel/Patches/CBlkDevFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Add floppy params to the CBlkDev class
+// FILE: ::/Kernel/KernelA.HH
+// TO INSTALL: #include this file after the second U32 declaration.
+
 U8	cyls,heads,spt,
 	srt,hut,hlt,
 	bps,gpl1,gpl2,
diff --git a/Kernel/Patches/KDefineBDTs.HC b/Kernel/Patches/KDefineBDTs.HC
index 1d55522..1ddeebf 100644
--- a/Kernel/Patches/KDefineBDTs.HC
+++ b/Kernel/Patches/KDefineBDTs.HC
@@ -1,2 +1,6 @@
+// PATCH: Add str for floppy BlkDev type to BlkDev str tbl
+// FILE: ::/Kernel/KDefine.HC
+// TO INSTALL: Comment out the old DefineLstLoad call, then #include this file.
+
 DefineLstLoad("ST_BLKDEV_TYPES",
 	"NULL\0RAM\0ATA\0FILE_READ\0FILE_WRITE\0ATAPI\0FLOPPY\0");
\ No newline at end of file
diff --git a/Kernel/Patches/KFloppyDMA.HC b/Kernel/Patches/KFloppyDMA.HC
index ce673cf..3f01bdb 100644
--- a/Kernel/Patches/KFloppyDMA.HC
+++ b/Kernel/Patches/KFloppyDMA.HC
@@ -4,6 +4,10 @@
     License. See the Copying.TXT file for details.

 */

 

+// PATCH: Adds a buf for floppy DMA xfers.

+// FILE: ::/Kernel/KStart32.HC

+// TO INSTALL: #include this file at the end.

+

 //U8 FDC_DMA[0x4800]; // Floppy DMA buffer

 

 U8 FDC_DMA[0x2400]; // Smaller buffer for one-track-at-a-time ops
\ No newline at end of file
diff --git a/Kernel/Patches/KernelABDTs.HH b/Kernel/Patches/KernelABDTs.HH
index 16cde0b..b300333 100644
--- a/Kernel/Patches/KernelABDTs.HH
+++ b/Kernel/Patches/KernelABDTs.HH
@@ -1,3 +1,7 @@
+// PATCH: Add floppy BlkDev type
+// FILE: ::/Kernel/KernelA.HH
+// TO INSTALL: Comment out the old #defines, then #include this file.
+
 #define BDT_NULL		0
 #define BDT_RAM 		1
 #define BDT_ATA 		2
diff --git a/Kernel/Patches/Let2BlkDevTypeFDC.HC b/Kernel/Patches/Let2BlkDevTypeFDC.HC
index 0632b88..3a2afc3 100644
--- a/Kernel/Patches/Let2BlkDevTypeFDC.HC
+++ b/Kernel/Patches/Let2BlkDevTypeFDC.HC
@@ -1,3 +1,7 @@
+// PATCH: Remaps ltrs W-Z for floppy drives
+// FILE: ::/Kernel/BlkDev/DskDrv.HC
+// TO INSTALL: Comment out the original function, then #include this file.
+
 I64 Let2BlkDevType(U8 drv_let)
 {//Drv letter to BlkDev Type. drv_let=0 not allowed. See BDT_NULL.
   drv_let=Let2Let(drv_let);