Fix RST warnings

Signed-off-by: ihutchin <ianeta.hutchinson@intel.com>
This commit is contained in:
ihutchin
2017-09-15 14:59:17 -07:00
parent 137f347775
commit df8f2275b7
7 changed files with 96 additions and 145 deletions
@@ -15,6 +15,10 @@ on bare metal using a bootable USB drive.
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum
.. include:: ../bootable-usb/bootable-usb-linux.rst
:Start-after: verify-checksum:
:end-before: copy-usb-linux
.. include:: ../bootable-usb/bootable-usb-linux.rst
@@ -24,7 +28,7 @@ on bare metal using a bootable USB drive.
.. _install-on-target:
Install Clear Linux on your target system
=========================================
*****************************************
The USB drive that was created in the previous step has been formatted as a
UEFI boot device. Our target system has a hard drive installed containing a
@@ -91,7 +95,7 @@ Follow these steps to install |CL| on the target system:
.. _initial-setup:
Clear Linux initial setup after installation
============================================
********************************************
Your newly installed |CL| boots on your target system and presents a full
screen console requesting `Login:`. |CL| is designed to install with minimal
@@ -99,7 +103,7 @@ software overhead. Therefore, some housekeeping and package installations
must occur before you have a full-featured |CL| operating system.
Set up your root and user accounts
----------------------------------
==================================
#. At the initial login prompt, enter: root
@@ -123,7 +127,7 @@ Remain logged in as the root user because there are some other things to do
before we can fully enable your new user space.
Software installation and updates
---------------------------------
=================================
|CL| has a unique application and architecture to add and update applications
and to perform system updates called software update utility or `swupd`.
@@ -153,7 +157,7 @@ We provide the full list of bundles and packages installed with the
list to view the manifest of the bundle.
Finish setting up your new user
-------------------------------
===============================
Before logging off as root and logging into your new user account, we must
enable the :command:`sudo` command for your new `<userid>`.
@@ -211,7 +215,7 @@ To be able to execute all applications with root privileges, we must add the
additional supporting applications.
Install a GUI
-------------
=============
#. To test the :command:`sudo` command and ensure we set it up correctly, we
can install the Gnome Desktop Manager (gdm) and start it.
@@ -258,7 +262,7 @@ Additionally, you performed the following basic setup for your system:
* Installed a GUI using those `sudo` privileges.
Next steps
==========
**********
With your system now running |CL| many paths are open for you.
@@ -276,3 +280,7 @@ system.
.. _`wheel group`:
https://en.wikipedia.org/wiki/Wheel_(Unix_term)
.. _image: https://download.clearlinux.org/image
.. _releases: https://download.clearlinux.org/releases
@@ -1,12 +1,12 @@
.. _bootable-usb-linux:
Create a bootable USB drive on Linux
==============================
Create a bootable USB drive on Linux
************************************
Follow these instructions to create a bootable |CL| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operatings are available:
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-windows`
@@ -14,7 +14,7 @@ Alternative instructions for other operatings are available:
.. _download-cl-image:
Download the latest Clear Linux image
-------------------------------------
=====================================
#. Go to the Clear Linux `image`_ repository and download the desired type:
@@ -23,141 +23,98 @@ Download the latest Clear Linux image
For older versions, see the `releases`_ page.
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
the image in order to verify its integrity.
.. Get the latest available |CL| image by using your web browser and downloading the latest
.. :file:`clear-[release]-installer.img.xz` file from
.. https://download.clearlinux.org/image/ where `[release]` is the release
.. number of the current image that is available in this directory listing.
.. ..note:
.. For installing Clear Linux as a live image, look for
.. “clear-[release]-live.img.xz”.
.. This example uses release 10980 so we will download the
.. :file:`clear-10980-installer.img.xz` image file and, optionally, the
.. :file:`clear-10980-installer.img.xz-SHA512SUMS` file needed to verify the
.. download.
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
the image in order to verify its integrity.
.. _verify-checksum:
Verify the integrity of the download (recommended)
--------------------------------------------------
==================================================
#. Start a terminal emulator.
#. Go to the directory with the downloaded files.
#. To verify the integrity of the image, enter the following (a `live` image
#. To verify the integrity of the image, enter the following (a live image
is used as example):
.. code-block:: console
$ sha512sum ./clear-<version>-live.img.xz | diff ./clear-<version>-live.img.xz-SHA512SUMS -
If the checksum of the downloaded image is different than the original's,
the differences will displayed. Otherwise, an empty output indicates a match.
If the checksum of the downloaded image is different than the original
checksum, the differences will displayed. An empty output indicates a match.
.. _copy-usb-linux:
Burn the Clear Linux image onto a USB drive
-----------------------------------------
.. This example was created on an Ubuntu 16.04-based system where the USB
.. drive is identified as :file:`/dev/sdb`. Make sure you map the correct USB
.. device for this process.
===========================================
.. caution::
The process of burning an image onto the USB drive completely formats it.
Thus, any existing contents on it will be destroyed. Backup important data
before proceeding.
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Open a terminal emulator and get root privilege.
.. code-block:: console
$ sudo -s
#. Plug in the USB drive.
#. Identify the USB drive using the `lsblk` command. This shows all drives
attached to the system, including the primary hard disk. In the example output
below, there are 4 drives (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached,
where `/dev/sda` is primary drive in this case. The remaining are 3 USB drives.
The output also shows the mounted partitions (under the `MOUNTPOINT`
column) for each drive.
#. Identify the USB drive using the `lsblk` command. This shows all drives
attached to the system, including the primary hard disk. In the example
output below, there are 4 drives (`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and
`/dev/sdd`) attached, where `/dev/sda` is primary drive in this case. The
remaining are 3 USB drives. The output also shows the mounted partitions
(under the `MOUNTPOINT` column) for each drive.
.. code-block:: console
# lsblk
Example output:
.. code-block:: console
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdd 8:48 1 15G 0 disk
sdd 8:48 1 15G 0 disk
├─sdd2 8:50 1 5G 0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
├─sdd3 8:51 1 8G 0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
└─sdd1 8:49 1 2G 0 part
sdb 8:16 1 14.8G 0 disk
└─sdd1 8:49 1 2G 0 part
sdb 8:16 1 14.8G 0 disk
└─sdb1 8:17 1 14.8G 0 part /run/media/user1/PATRIOT_USB
sdc 8:32 1 7.3G 0 disk
sdc 8:32 1 7.3G 0 disk
└─sdc1 8:33 1 7.3G 0 part /run/media/user1/LINUX MINT
sda 8:0 0 335.4G 0 disk
├─sda4 8:4 0 28G 0 part
sda 8:0 0 335.4G 0 disk
├─sda4 8:4 0 28G 0 part
├─sda2 8:2 0 3.7G 0 part [SWAP]
├─sda7 8:7 0 6G 0 part /home
├─sda5 8:5 0 1G 0 part /boot
├─sda3 8:3 0 954M 0 part /boot/efi
├─sda1 8:1 0 28G 0 part
├─sda1 8:1 0 28G 0 part
├─sda8 8:8 0 30G 0 part /
└─sda6 8:6 0 7.9G 0 part [SWAP]
#. Before an image can be burned onto a USB drive, it should be un-mounted. Some
Linux distros may automatically mount a USB drive when it is plugged in. To
unmount, use the `umount` command followed by the device identifier/partition.
For example: From the above `lsblk` output, `/dev/sdd` has 2 mounted partitions.
Both will be umounted as follows:
#. Before an image can be burned onto a USB drive, it should be un-mounted.
Some Linux distros may automatically mount a USB drive when it is plugged
in. To unmount, use the `umount` command followed by the device
identifier/partition. For example: From the above `lsblk` output,
`/dev/sdd` has 2 mounted partitions.
.. code-block:: console
# umount /dev/sdd2
# umount /dev/sdd3
#. Extract the downloaded image file and burn it onto the USB drive (`/dev/sdd` is used as an example).
#. Extract the downloaded image file and burn it onto the USB drive (`/dev/sdd`
is used as an example).
.. code-block:: console
# xzcat clear-<version>-live.img.xz | dd of=/dev/sdd bs=4M status=progress
.. . Uncompress the image.
.. codeblock console
.. # unxz clear-<version>-live.img.xz
.. Burn the image onto the USB drive (for example `/dev/sdd`).
.. codeblock console
.. # dd if=/path/to/clear-<version>-live.img of=/dev/sdd bs=4M status=progress
.. #. Ensure the device is not mounted.
.. code-block console
.. umount /dev/sdb
.. Log in as root.
.. code-block console
.. su
.. Once prompted, enter your root password. Alternatively you can enter:
.. code-block console
.. sudo -s
.. note
.. These commands only work in the directory containing the downloaded
.. file.
.. The decompression and copy of the image file takes some time to complete.
.. _usb-next:
Next steps
@@ -169,6 +126,7 @@ With a bootable |CL| USB drive, you can:
* :ref:`boot-live-image`
* :ref:`multi-boot`
.. _releases: https://download.clearlinux.org/releases
.. _image: https://download.clearlinux.org/image
.. _releases: https://download.clearlinux.org/releases
@@ -1,22 +1,22 @@
.. _bootable-usb-mac:
Create a bootable USB drive on macOS
====================================
************************************
Follow these instructions to create a bootable |CL| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operatings are available:
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-windows`
.. include:: bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum:
:end-before: verify-checksum
Verify the integrity of the download (recommended)
--------------------------------------------------
==================================================
#. Start the Terminal app.
#. Go to the directory with the downloaded files.
@@ -26,28 +26,17 @@ Verify the integrity of the download (recommended)
$ shasum -a512 ./clear-<version>-live.img.xz | diff ./clear-<version>-live.img.xz-SHA512SUMS -
If the checksum of the downloaded image is different than the original's,
If the checksum of the downloaded image is different than the original's,
the differences will displayed. Otherwise, an empty output indicates a match.
Burn the Clear Linux image onto a USB drive
-----------------------------------------
.. This example was created on an Ubuntu 16.04-based system where the USB
.. drive is identified as :file:`/dev/sdb`. Make sure you map the correct USB
.. device for this process.
===========================================
.. caution::
The process of burning an image onto the USB drive completely formats it.
Thus, any existing contents on it will be destroyed. Backup important data
before proceeding.
.. Copy the Clear Linux image to a USB drive
.. -----------------------------------------
.. Copying the |CL| image onto the USB drive formats the drive as a UEFI boot
.. device. Therefore, the contents of the USB drive will be destroyed during the
.. creation of the bootable USB drive. Make sure to save anything stored in the
.. drive before proceeding.
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Launch the Terminal application.
@@ -66,8 +55,8 @@ Burn the Clear Linux image onto a USB drive
.. figure:: figures/bootable-usb-mac-1.png
:alt: Get USB drive identifier
#. Unmount the USB drive identified in the previous step (using `/dev/disk2` as
the example)
#. Unmount the USB drive identified in the previous step (using `/dev/disk2`
as the example)
.. code-block:: console
@@ -79,8 +68,9 @@ Burn the Clear Linux image onto a USB drive
$ sudo dd if=/path/to/clear-<version>-live.img of=/dev/rdisk2 bs=4m
* Adding an r in front of the disk identifier should help speed up the imaging process.
* Use `<CTL>-T` to check imaging progress.
* Adding an r in front of the disk identifier should help speed up the
imaging process.
* Use `<CTL>-T` to check imaging progress.
#. Eject the USB drive.
@@ -1,26 +1,23 @@
.. _bootable-usb-windows:
Create a bootable USB drive on Windows
======================================
**************************************
Follow these instructions to create a bootable |CL| USB drive.
Use an **8GB** or larger USB drive.
Alternative instructions for other operatings are available:
Alternative instructions for other operating systems are available:
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-linux`
.. include:: bootable-usb-linux.rst
:Start-after: download-cl-image:
:end-before: verify-checksum:
.. copy-usb-windows
:end-before: verify-checksum
Verify the integrity of the download (recommended)
--------------------------------------------------
==================================================
.. _verify-checksum-on-windows:
#. Start Command-Prompt.
#. Go to the directory with the downloaded files.
#. To verify the integrity of the image, enter the following commands:
@@ -32,13 +29,13 @@ Verify the integrity of the download (recommended)
Compare the output with the original checksum to make sure they match.
Burn the Clear Linux image onto a USB drive
-----------------------------------------
===========================================
.. caution::
The process of burning an image onto the USB drive completely formats it.
Thus, any existing contents on it will be destroyed. Backup important data
before proceeding.
Backup important data before proceeding. The process of burning an image
onto the USB drive completely formats the
USB drive and any existing content will be destroyed.
#. Download the `Rufus`_ tool to burn the image onto a USB drive.
@@ -1,7 +1,7 @@
.. _compatibility-check:
Check processor and EFI firmware compatibility with Clear Linux\*
=================================================================
*****************************************************************
On a system that is currently running a Linux operating system, follow the
instructions below to determine if your system's processor and EFI firmware is
+17 -20
View File
@@ -3,33 +3,30 @@
Install Clear Linux as a Live image
###################################
A live image contains the complete Clear Linux operating system that resides
on a bootable media such as a USB drive or in a virtual machine
(see :ref:`virtual-machine-install`). This is a
A live image contains the complete |CL| operating system and resides
on a bootable media such as a USB drive or in a virtual machine
(see :ref:`virtual-machine-install`). This is a
great way to use |CL| without modifying your computer's hard disk.
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: bootable-usb-linux:
:end-before: download-cl-image:
:end-before: download-cl-image
Download the latest Clear Linux Live image
------------------------------------------
******************************************
#. Get the latest |CL| Live image from the `image`_ page. Look for
`clear-<version>-live.img.xz`.
#. Get the latest |CL| Live image from the `image`_ page. Look for
`clear-<version>-live.img.xz`.
For older versions, see the `releases`_ page.
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
#. Although not required, it is recommended to download the corresponding
checksum file (designated with `-SHA512SUMS` at the end of the filename) for
the image in order to verify its integrity.
.. Download the ``clear-<version>-live.img.xz``
.. image in the `current`_ version's download directory.
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: verify-checksum:
:end-before: verify-checksum-on-macos:
:Start-after: verify-checksum:
:end-before: verify-checksum-on-macos
.. include:: bootable-usb/bootable-usb-linux.rst
:Start-after: copy-usb-linux:
@@ -37,13 +34,13 @@ Download the latest Clear Linux Live image
.. _boot-live-image:
Boot the Clear Linux Live image
================================
Boot the Clear Linux Live image
*******************************
#. Configure the BIOS/UEFI firmware settings of the target system as follows:
* Enable `Intel® Virtualization Technology (Intel® VT)`_
* Enable `Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`_
* Disable `Secure Boot`
#. Configure the BIOS/UEFI firmware settings of the target system:
* Enable `Intel® Virtualization Technology (Intel® VT)`_
* Enable `Intel® Virtualization Technology for Directed I/O (Intel® VT-d)`_
* Disable `Secure Boot`
#. Plug the imaged USB drive in and boot it up.
@@ -76,7 +76,8 @@ installation of the tested operating systems.
Install the Clear Linux OS
**************************
#. Create a bootable USB drive of the |CL| installer using one of the methods below.
#. Create a bootable USB drive of the |CL| installer using one of the methods
below.
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-mac`