diff --git a/dev/builds.rst b/dev/builds.rst new file mode 100644 index 0000000..2aa2837 --- /dev/null +++ b/dev/builds.rst @@ -0,0 +1,56 @@ +Advanced builds +=============== + +The `86Box Jenkins `_ provides all kinds of pre-release testing builds for advanced users. These are linked to the `86Box git repository on GitHub `_; a new build is produced with the latest source code every time the repository is updated. + +.. important:: Testing builds are development snapshots which may contain bugs, incomplete features or other issues. These should only be used if you know what you're doing. + +Standard +-------- + +Standard builds (**86Box**) are compiled with default options. Release versions of 86Box are based on these. + +Debug +----- + +Debug builds (**86Box-Debug**) are :ref:`standard builds ` compiled with debug symbols and no optimizations, to allow for debugging with ``gdb`` and other tools if you don't have a full 86Box development setup. These run slower than standard builds due to the removal of optimizations and addition of debugging features. + +Development +----------- + +Development builds (**86Box-Dev**) are compiled with ``DEV_BUILD=y``, enabling additional features which are currently under development. These new features might not work, either partially or entirely, and the development team reserves the right to change or remove them at any time. + +Optimized +--------- + +Optimized builds (**86Box-Optimized**) are :ref:`standard builds ` which have been optimized for use with a specific CPU family on the host machine. These provide slight performance improvements, especially on older or low-end hosts; however, the aggressive optimizations employed **may result in bugs** not present on standard builds. + +There are many different optimized binaries available for each build; you must download the **correct one for your host CPU**, otherwise, 86Box will run poorly or even crash. The table below lists most CPUs currently supported by optimized builds, along with the respective binaries you should use with them, as well as their codenames (as shown on an identification tool such as `CPU-Z `_): + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + +
BinaryCPUsCodenames
Intel
Core2Core 2 Duo/Quad
Pentium Dual-Core		Conroe, Allendale, Merom,
Kentsfield, Wolfdale, Yorkfield
Nehalem1st generation CoreBloomfield, Lynnfield, Gulftown,
Arrandale, Clarkdale, Clarksfield
SandyBridge2nd/3rd generation CoreSandy Bridge, Ivy Bridge
Haswell4th/5th generation CoreHaswell, Broadwell
Skylake6th/7th/8th/9th/10th generation CoreSkylake, Kaby Lake, Coffee Lake,
Whiskey Lake, Amber Lake, Comet Lake
IceLake10th/11th generation CoreIce Lake, Tiger Lake, Rocket Lake
BonnellAtom (2008-2012)Silverthorne, Diamondville, Lincroft,
Pineview, Cedar Trail, Cover Trail
SilvermontAtom (2013+)Bay Trail, Cherry Trail, Braswell
N/J-series Celeron/PentiumBay Trail, Braswell, Apollo Lake,
Gemini Lake, Skyhawk Lake
AMD
K8 *All (2005-2007)
K10All (2008-2010)
BobcatAthlon (2011+)
FX
A/C/E-Series APU		Ontario, Zacate, Hondo, Llano, Trinity,
Richland, Kabini, Kaveri, Beema, Mullins,
Carrizo, Bristol Ridge, Stoney Ridge
ZenRyzen 1000/2000 CPU
Ryzen 2000/3000 APU **		Summit Ridge, Raven Ridge, Dali,
Pinnacle Ridge, Picasso
Ryzen Threadripper 1000/2000Whitehaven, Colfax
Zen2Ryzen 3000/4000 CPU
Ryzen 4000 APU **		Matisse, Renoir, Vermeer
Ryzen Threadripper 3000Castle Peak
+ +| \* Older K8 CPUs without SSE3 are not supported. +| \*\* Ryzen APU = models equipped with integrated graphics, including G-series on desktop and U/H-series on mobile. These are always one generation behind; the model numbers are misleading. diff --git a/formats/86f.rst b/dev/formats/86f.rst similarity index 100% rename from formats/86f.rst rename to dev/formats/86f.rst diff --git a/formats/hdx.rst b/dev/formats/hdx.rst similarity index 100% rename from formats/hdx.rst rename to dev/formats/hdx.rst diff --git a/dev/formats/index.rst b/dev/formats/index.rst new file mode 100644 index 0000000..0e93d69 --- /dev/null +++ b/dev/formats/index.rst @@ -0,0 +1,11 @@ +File formats +============ + +86Box introduces new file formats for disk images and other purposes. These formats are documented on this section. + +.. toctree:: + :maxdepth: 1 + :caption: Formats + + 86f + hdx diff --git a/hardware/diskimages.rst b/hardware/diskimages.rst index a99b4e5..4b6346d 100644 --- a/hardware/diskimages.rst +++ b/hardware/diskimages.rst @@ -3,22 +3,25 @@ Disk images 86Box supports a large variety of disk image formats for the emulated disk drives. +.. |86f| replace:: :doc:`../dev/formats/86f` +.. |hdx| replace:: :doc:`../dev/formats/hdx` + Hard disk images ---------------- Supported formats: -+---------------------+--------------+ -|Format |File extension| -+=====================+==============+ -|**Raw image** |Many * | -+---------------------+--------------+ -|Japanese FDI |.hdi | -+---------------------+--------------+ -|:doc:`../formats/hdx`|.hdx | -+---------------------+--------------+ -|Virtual Hard Disk |.vhd | -+---------------------+--------------+ ++-----------------+--------------+ +|Format |File extension| ++=================+==============+ +|**Raw image** |Many * | ++-----------------+--------------+ +|Japanese FDI |.hdi | ++-----------------+--------------+ +||hdx| |.hdx | ++-----------------+--------------+ +|Virtual Hard Disk|.vhd | ++-----------------+--------------+ \* Raw images come in many extensions, including: img ima @@ -46,31 +49,31 @@ Floppy disk images Supported formats: -+---------------------+--------------+ -|Format |File extension| -+=====================+==============+ -|**Raw image** |Many * | -+---------------------+--------------+ -|:doc:`../formats/86f`|.86f | -+---------------------+--------------+ -|Formatted Disk Image |.fdi | -+---------------------+--------------+ -|CopyQM |.cqm | -+---------------------+--------------+ -|DiskDupe |.ddi | -+---------------------+--------------+ -|EZ-DisKlone Plus |.fdf | -+---------------------+--------------+ -|HxC MFM |.mfm | -+---------------------+--------------+ -|ImageDisk |.imd | -+---------------------+--------------+ -|Japanese FDI |.fdi | -+---------------------+--------------+ -|PCjs JSON |.json | -+---------------------+--------------+ -|Teledisk |.td0 | -+---------------------+--------------+ ++--------------------+--------------+ +|Format |File extension| ++====================+==============+ +|**Raw image** |Many * | ++--------------------+--------------+ +||86f| |.86f | ++--------------------+--------------+ +|Formatted Disk Image|.fdi | ++--------------------+--------------+ +|CopyQM |.cqm | ++--------------------+--------------+ +|DiskDupe |.ddi | ++--------------------+--------------+ +|EZ-DisKlone Plus |.fdf | ++--------------------+--------------+ +|HxC MFM |.mfm | ++--------------------+--------------+ +|ImageDisk |.imd | ++--------------------+--------------+ +|Japanese FDI |.fdi | ++--------------------+--------------+ +|PCjs JSON |.json | ++--------------------+--------------+ +|Teledisk |.td0 | ++--------------------+--------------+ \* Raw images come in many extensions, including: img ima flp vfd diff --git a/index.rst b/index.rst index 2845791..f8452e3 100644 --- a/index.rst +++ b/index.rst @@ -44,7 +44,7 @@ to retro computing and, of course, 86Box. We look forward to hearing from you! .. toctree:: :maxdepth: 1 - :caption: File formats + :caption: Development - formats/86f - formats/hdx + dev/builds + dev/formats/index diff --git a/usage/statusbar.rst b/usage/statusbar.rst index b36bc6c..763810e 100644 --- a/usage/statusbar.rst +++ b/usage/statusbar.rst @@ -30,7 +30,7 @@ A 3.5" or 5.25" floppy icon will appear for each configured :ref:`floppy drive < * **New image:** create a new disk image file. Opens the *New Image* window, which lets you select the image size and where to save the file. * **Existing image:** insert a :ref:`disk image file ` into this drive. * **Existing image (Write-protected):** insert a disk image file into this drive as a read-only disk. -* **Export to 86F:** convert the currently-inserted disk image file to 86Box's :doc:`../formats/86f` surface image format. You will be asked where to save the converted file. +* **Export to 86F:** convert the currently-inserted disk image file to 86Box's :doc:`../dev/formats/86f` surface image format. You will be asked where to save the converted file. * **Eject:** remove the currently-inserted disk from this drive. |cdrom| |nbsp| CD-ROM drives