Browse Source

docs: user/x86

Fixes #373
Matthias Schiffer 9 years ago
parent
commit
279ac23d83
2 changed files with 34 additions and 0 deletions
  1. 5 0
      docs/index.rst
  2. 29 0
      docs/user/x86.rst

+ 5 - 0
docs/index.rst

@@ -13,6 +13,7 @@ User Documentation
 
    user/getting_started
    user/site
+   user/x86
    user/faq
 
 Features
@@ -152,10 +153,14 @@ x86-generic
 * x86-virtualbox
 * x86-vmware
 
+See also: :doc:`user/x86`
+
 x86-kvm_guest
 ^^^^^^^^^^^^^
 * x86-kvm
 
+See also: :doc:`user/x86`
+
 License
 -------
 

+ 29 - 0
docs/user/x86.rst

@@ -0,0 +1,29 @@
+x86 support
+===========
+
+Gluon can run on normal x86 systems, for example virtual machines
+and VPN boxes. There is no WLAN support on x86 though.
+
+Targets
+^^^^^^^
+
+There are two targets for x86 images:
+
+`x86-generic`
+    Generic x86 support with many different ethernet drivers; should run on
+    most x86 systems.
+
+    There are three images:
+
+    * `generic` (compressed "raw" image, can written to a disk directly or booted with qemu)
+    * `virtualbox` (VDI image)
+    * `vmware` (VMDK image)
+
+    These images only differ in the image file format, the content is the same. Therefore there is
+    only a single `x86-generic` sysupgrade image instead of three.
+
+    Please note that the `x86-generic` image doesn't include VirtIO support, so another virtual NIC
+    like `pcnet32` must be chosen when using VirtualBox.
+
+`x86-kvm`
+    The `x86-kvm` image uses VirtIO as its harddisk and network driver.