- reST formatting clean up

- Remove generic prompt ("$") from example command lines, for consistency
- Update example command lines in kvm.rst to use codeblock:bash instead of codeblock::console, for consistency

Signed-off-by: Kristal Dale <kristal.dale@intel.com>
This commit is contained in:
Kristal Dale
2018-09-27 10:51:07 -07:00
parent 9b65f735b5
commit 8b85477a25
5 changed files with 61 additions and 61 deletions
@@ -35,7 +35,7 @@ Burn the |CL| image onto a USB drive
.. code-block:: console
$ diskutil list
diskutil list
.. figure:: figures/bootable-usb-mac-1.png
:scale: 100 %
@@ -48,14 +48,14 @@ Burn the |CL| image onto a USB drive
.. code-block:: console
$ diskutil umountDisk /dev/disk2
diskutil umountDisk /dev/disk2
#. Burn the image onto the drive using the :command:`dd` command. The
command-line example below burns an uncompressed image onto `/dev/disk2`:
.. code-block:: console
$ sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m
sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m
Adding an ‘r’ in front of the disk identifier should help speed up the
@@ -67,7 +67,7 @@ Burn the |CL| image onto a USB drive
.. code-block:: console
$ diskutil eject /dev/disk2
diskutil eject /dev/disk2
Next steps
**********
@@ -14,8 +14,8 @@ Download the latest |CL| image
There are 2 types of |CL| images suitable for burning onto and running
off a USB drive:
* Live image: :file:`clear-[version number]-live.img.xz`
* Installer image: :file:`clear-[version number]-installer.img.xz`
* Live image: :file:`clear-[version number]-live.img.xz`
* Installer image: :file:`clear-[version number]-installer.img.xz`
Go to the |CL| `image`_ repository and download the desired type.
@@ -19,13 +19,13 @@ below.
.. code-block:: console
$ curl -O https://download.clearlinux.org/current/clear-linux-check-config.sh
curl -O https://download.clearlinux.org/current/clear-linux-check-config.sh
#. Make the script executable.
.. code-block:: console
$ chmod +x clear-linux-check-config.sh
chmod +x clear-linux-check-config.sh
#. Run the script.
@@ -34,13 +34,13 @@ below.
.. code-block:: console
$ ./clear-linux-check-config.sh host
./clear-linux-check-config.sh host
#. Check to see if the host is capable of running |CL| in a container.
.. code-block:: console
$ ./clear-linux-check-config.sh container
./clear-linux-check-config.sh container
The script will print a list of test results similar to the output below.
All items should return a `SUCCESS` status. This example indicates the
@@ -16,35 +16,35 @@ Install QEMU-KVM
#. Log in, open a terminal emulator, and get root privilege on the host
machine:
.. code-block:: console
.. code-block:: bash
$ sudo -s
sudo -s
#. Install `QEMU*-KVM` on the host machine. Below are some example distros.
* On |CL|:
.. code-block:: console
.. code-block:: bash
# swupd bundle-add desktop-autostart kvm-host
swupd bundle-add desktop-autostart kvm-host
* On Ubuntu\* 16.04 LTS Desktop:
.. code-block:: console
.. code-block:: bash
# apt-get install qemu-kvm
apt-get install qemu-kvm
* On Mint\* 18.1 “Serena” Desktop:
.. code-block:: console
.. code-block:: bash
# apt-get install qemu-kvm
apt-get install qemu-kvm
* On Fedora\* 25 Workstation:
.. code-block:: console
.. code-block:: bash
# dnf install qemu-kvm
dnf install qemu-kvm
Download and launch the virtual machine
=======================================
@@ -59,9 +59,9 @@ Download and launch the virtual machine
#. Uncompress the downloaded image:
.. code-block:: console
.. code-block:: bash
# unxz clear-<version>-kvm.img.xz
unxz clear-<version>-kvm.img.xz
#. Download the `OVMF file`_ file that provides UEFI support for
virtual machines from the `image <https://download.clearlinux.org/image/>`_
@@ -74,15 +74,15 @@ Download and launch the virtual machine
#. Make the script executable:
.. code-block:: console
.. code-block:: bash
# chmod +x start_qemu.sh
chmod +x start_qemu.sh
#. Start the |CL| KVM virtual machine:
.. code-block:: console
.. code-block:: bash
# ./start_qemu.sh clear-<version>-kvm.img
./start_qemu.sh clear-<version>-kvm.img
#. Log in as ``root`` user and set a new password.
@@ -93,18 +93,18 @@ launched from, follow these steps.
#. Enable SSH in the |CL| VM:
.. code-block:: console
.. code-block:: bash
# cat > /etc/ssh/sshd_config << EOF
cat > /etc/ssh/sshd_config << EOF
PermitRootLogin yes
EOF
#. From the host, SSH into the |CL| VM. The port number ``10022`` is defined
in the ``start_qemu.sh`` script.
.. code-block:: console
.. code-block:: bash
# ssh -p 10022 root@localhost
ssh -p 10022 root@localhost
Add the GNOME Display Manager (GDM)
===================================
@@ -113,35 +113,35 @@ To add :abbr:`GDM (GNOME Display Manager)` to the |CL| VM, follow these steps:
#. Shutdown the active |CL| VM.
.. code-block:: console
.. code-block:: bash
# shutdown now
shutdown now
#. Install a VNC viewer on the host machine. Below are some example distros.
* On Clear Linux:
.. code-block:: console
.. code-block:: bash
# swupd bundle-add desktop-apps-extras
swupd bundle-add desktop-apps-extras
* On Ubuntu\* 16.04 LTS Desktop:
.. code-block:: console
.. code-block:: bash
# apt-get install vncviewer
apt-get install vncviewer
* On Mint\* 18.1 “Serena” Desktop:
.. code-block:: console
.. code-block:: bash
# apt-get install vncviewer
apt-get install vncviewer
* On Fedora\* 25 Workstation:
.. code-block:: console
.. code-block:: bash
# dnf install tigervnc
dnf install tigervnc
#. Modify the :file:`start_qemu.sh` script to increase memory (``-m``), add
graphics driver (``-vga``), and add VNC (``-vnc``, ``-usb``, and
@@ -169,48 +169,48 @@ To add :abbr:`GDM (GNOME Display Manager)` to the |CL| VM, follow these steps:
#. Relaunch the |CL| VM. The UEFI shell will appear.
.. code-block:: console
.. code-block:: bash
# ./start_qemu.sh clear-<version>-kvm.img
./start_qemu.sh clear-<version>-kvm.img
#. At the UEFI shell, delete the :file:`NvVars` file:
.. code-block:: console
.. code-block:: bash
Shell> del FS0:\NvVars
#. Exit out of the UEFI shell:
.. code-block:: console
.. code-block:: bash
Shell> reset -s
#. Relaunch the |CL| VM:
.. code-block:: console
.. code-block:: bash
# ./start_qemu.sh clear-<version>-kvm.img
./start_qemu.sh clear-<version>-kvm.img
#. From the host machine, open a new terminal emulator window and VNC into the
|CL| VM:
.. code-block:: console
.. code-block:: bash
# vncviewer 0.0.0.0
vncviewer 0.0.0.0
#. Log in as ``root`` user into the |CL| VM.
#. Add GDM to the |CL| VM:
.. code-block:: console
.. code-block:: bash
# swupd bundle-add desktop-autostart
swupd bundle-add desktop-autostart
#. Reboot the |CL| VM to enable GDM:
.. code-block:: console
.. code-block:: bash
# reboot
reboot
#. Go through GDM's out-of-box experience (OOBE).
@@ -46,19 +46,19 @@ Install the VMware Workstation Player hypervisor
* On supported Linux distros:
#. Enable a GUI desktop.
#. Start a terminal emulator.
#. Start the installer by issuing the command below and follow the
guided steps.
#. Enable a GUI desktop.
#. Start a terminal emulator.
#. Start the installer by issuing the command below and follow the
guided steps.
.. code-block:: console
.. code-block:: console
$ sudo sh ./VMware-Player-[version number].x86_64.bundle
sudo sh ./VMware-Player-[version number].x86_64.bundle
* On Windows:
#. Start the installer.
#. Follow the setup wizard.
#. Start the installer.
#. Follow the setup wizard.
For additional help, see the `VMware Workstation Player guide`_.
@@ -253,7 +253,7 @@ Enable UEFI boot support
|CL| needs UEFI support to boot. To enable UEFI, add the
following line to the end of your VM's :file:`.vmx` file:
.. code-block:: bash
.. code-block:: console
firmware = "efi"