Corrects Sphinx syntax, spelling, and document formatting.

Signed-off-by: Michael Vincerra <michaelx.vincerra@intel.com>
This commit is contained in:
Michael Vincerra
2018-06-29 13:40:53 -07:00
parent 053d57c682
commit 5379715cf9
+16 -17
View File
@@ -1,6 +1,6 @@
.. _image-types:
Clear Linux image types
Clear Linux\* image types
#######################
.. _image-types-content:
@@ -9,22 +9,22 @@ Clear Linux image types
The naming convention of a |CL| image filename is:
.. code-block:: console
.. code-block:: console
clear-[version number]-[image type].[compression type]
clear-[version number]-[image type].[compression type]
The *[version number]* field specifies the version number.
* The *[version number]* field specifies the version number.
The *[image type]* field specifies the type of image and its corresponding
file format.
* The *[image type]* field specifies the type of image and its corresponding
file format.
The *[compression type]* field specifies the compression type. Two types of
compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*).
* The *[compression type]* field specifies the compression type. Two types of
compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*).
Table 1 lists the currently available images which are platform independant.
Table 2 lists the currently available images which are platform specific.
Table 1 lists the currently available images that are platform independent.
Table 2 lists the currently available images that are platform specific.
.. list-table:: Table 1: Types of platform independant Clear Linux images
.. list-table:: Table 1: Types of platform-independent Clear Linux images
:widths: 15, 85
:header-rows: 1
@@ -40,9 +40,7 @@ Table 2 lists the currently available images which are platform specific.
* - live.img
- image for live booting into memory, without requiring installaton.
.. list-table:: Table 2: Types of platform specific Clear Linux images
.. list-table:: Table 2: Types of platform-specific Clear Linux images
:widths: 15, 85
:header-rows: 1
@@ -53,10 +51,10 @@ Table 2 lists the currently available images which are platform specific.
- Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform
* - azure-docker.vhd
- Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform with Docker\* pre-installed
- Virtual Hard Disk for use on Microsoft Azure cloud platform with Docker\* pre-installed
* - azure-machine-learning.vhd
- Virtual Hard Disk for use on Microsoft\* Azure\* cloud platform with the `machine-learning-basic` bundle installed
- Virtual Hard Disk for use on Microsoft Azure cloud platform with the `machine-learning-basic` bundle installed
* - cloud.img
- Image for use by cloud deployments such as OpenStack\*
@@ -68,7 +66,8 @@ Table 2 lists the currently available images which are platform specific.
- Virtual Hard Disk for use with Microsoft Hyper-V\* hypervisor. Includes `optimized kernel`_ for Hyper-V.
* - kvm.img
- Image for booting in a simple VM with start_qemu.sh. Includes `optimized kernel`_ for KVM.
- Image for booting in a simple VM with start_qemu.sh. Includes
`optimized kernel`_ for KVM.
* - vmware.vmdk
- Virtual Machine Disk for VMware\* platforms inclduing Player, Workstation, and ESXi.