workbench/system/BHFormat/BHFormat.doc

   1 1. INTRODUCTION
   2 ---------------
   3
   4 BH Format is intended to be a compatible replacement for Format
   5 version 40 (AmigaOS up to v3.1) or version version 50 (MorphOS up to 1.4.5)
   6 with important additions:
   7
   8 * It can perform low-level formats (or fake formats, as they usually are)
   9   on drives larger than 4 GB (AmigaOS v40 Format command will destroy data
  10   on such a drive).
  11
  12 * It will warn you if the device to be formatted is misconfigured or if
  13   your file-system or if your disk is too large for your current device
  14   driver or file-system to handle (only for m68k).
  15
  16 * It allows you to specify file-system type (DosType) and device flags
  17   directly.  This will be particularly useful in conjunction with firth-
  18   coming improvements to Francis Swift's XFS package.
  19
  20 * It can create a default disk icon, following the same rules as the
  21   DefIcons program from NewIcons does.
  22
  23 * It has a GUI (native MorphOS version lacks it), can be used as a module for
  24   ScalOS desktop.
  25
  26 Also BH Format is a native formatting utility for AROS.
  27
  28 It currently lacks localisation, some error reporting code, and good
  29 documentation.  However, full source code is included and licensed
  30 under the GNU GPL, so perhaps I can get some help with this...
  31
  32 2. INSTALLATION
  33 ---------------
  34
  35 1. Copy Format program together with its icon (Format.info) to SYS:System
  36 directory (replacing original program on m68k AmigaOS).
  37
  38 2. On MorphOS: delete (or rename) original MOSSYS:C/Format utility and add
  39 the following command to your S:User-startup file:
  40
  41 Path SYS:System ADD
  42
  43 3. To install as a ScalOS module execute the following command:
  44
  45 MakeLink Scalos:Modules/Format_Disk.module SYS:System/Format
  46
  47
  48 3. AUTHOR
  49 ---------
  50
  51 Please send bug reports, success reports, fixes and improvements to
  52 me.
  53
  54         Pavel Fedin
  55         RUSSIA
  56
  57         email: sonic_amiga@rambler.ru
  58
  59 Original author of this program is:
  60
  61         Ben Hutchings
  62         8 Primrose Street
  63         Cambridge
  64         CB4 3EH
  65         ENGLAND
  66
  67         email: womble@zzumbouk.demon.co.uk
  68
  69 4. HISTORY
  70 ----------
  71
  72 12 February 2009
  73
  74 - GUI for selecting device added so it is possible to start from Wanderer.
  75 - Device was not released when formatting was interrupted by user or error.
  76
  77 Version 43.6, 28 June 2008.
  78
  79 Fixed one minor and one major bug:
  80
  81 - Turns on cursor if interrupted by the user
  82 - Cancelling formatting using CTRL-C really works
  83
  84 Version 43.5, 15 June 2008.
  85
  86 Ported to MorphOS and AROS
  87
  88 Does not hold a lock on DosList for a long time
  89
  90 Fixed bug: track buffer size size was undefined when formatting
  91 non-FFS partitions, this could cause memory trashing.
  92
  93 Version 43.4, 9 June 1999.
  94
  95 Fixed 2 medium and 4 minor bugs:
  96
  97 - In the GUI, the logic of the trashcan check-box was inverted.
  98 - Starting Format from Workbench with the icon of an ejected disk
  99   would result in formatting whatever was currently in the drive
 100   that the ejected volume was previously in.  It should, and now
 101   does, ask for the ejected disk to be re-inserted and fail if
 102   the user refuses.
 103
 104 - The warning about MaxTransfer setting had several words repeated.
 105 - The default disk icon for a file-system type would not be fetched
 106   unless a file-system type was specified using the CLI DOSTYPE
 107   keyword.
 108 - The area cleared after formatting the disk and before displaying
 109   "Initializing disk..." was calculated wrongly (typo).
 110 - The positions of the ticks on the format progress bar were
 111   calculated slightly wrongly.
 112
 113 Version 43.3, 6 June 1999.
 114
 115 Changed all variable and function names to Hungarian naming
 116 convention (the real thing, not Micro$oft's botched version).
 117 Hopefully this makes the code easy to understand.
 118
 119 Restructured the program so that the GUI and CLI procedures can
 120 share as much code as possible.  Changed error reporting code to
 121 use a single function that will print the message to the console
 122 or display it in a requester depending on how the program was
 123 started.
 124
 125 Wrote almost all the necessary GUI code (search for TODO: in gui.c
 126 to find the missing bits).  The GUI is, of course, font-sensitive.
 127
 128 Added another rule for finding default disk icons - if there isn't
 129 a default icon for the device then the program looks for a default
 130 icon for the file-system type before finally asking icon.library
 131 for the default disk icon.  This should now match DefIcons rules
 132 exactly.
 133
 134 Version 43.2, 25 April 1999.
 135
 136 Added DOSTYPE keyword for specifying file-system type to handlers
 137 that implement multiple non-native types.  Added FLAGS keyword for
 138 specifying non-standard flags when opening the device driver.
 139 Added NOVERIFY switch for disabling format verification (pointless).
 140 Added DISKICON switch for putting a default disk icon on the disk.
 141 Marked comments on unimplemented stuff with "TODO" so that they're
 142 easy to find.
 143
 144 Version 43.1, 13 April 1999.
 145
 146 The product of some hours' hacking last year, and a little
 147 clean-up recently.
 148