Documentation: fix code block and literal block highlighting

Use shell script highlighting where it is resonable, use console
highlighting for transcripts, and fix some of the few cases where the
syntax was broken, resulting in text not being rendered at all.

Signed-off-by: Roland Hieber <r.hieber@pengutronix.de>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>

17 files changed, 101 insertions, 34 deletions

diff --git a/Documentation/boards/imx.rst b/Documentation/boards/imx.rst
index db889ee702..56fd3ab41c 100644
--- a/Documentation/boards/imx.rst
+++ b/Documentation/boards/imx.rst
@@ -32,7 +32,9 @@ Normally it's not necessary to call this tool manually, it is executed
 automatically at the end of the build process.
 
 The images generated by the build process can be directly written to an
-SD card::
+SD card:
+
+.. code-block:: sh
 
   # with Multi Image support:
   cat images/barebox-freescale-imx51-babbage.img > /dev/sdd
@@ -152,7 +154,9 @@ contains a USB upload tool. As it depends on the libusb development headers,
 it is not built by default. Enable it explicitly in ``make menuconfig``
 and install the libusb development package. On Debian, this can be done
 with ``apt-get install libusb-dev``. After compilation, the tool can be used
-with only the image name as argument::
+with only the image name as argument:
+
+.. code-block:: sh
 
   scripts/imx/imx-usb-loader images/barebox-freescale-imx51-babbage.img
 
diff --git a/Documentation/boards/imx/amazon-kindle-3.rst b/Documentation/boards/imx/amazon-kindle-3.rst
index dffb7efb2d..6b5d9fe535 100644
--- a/Documentation/boards/imx/amazon-kindle-3.rst
+++ b/Documentation/boards/imx/amazon-kindle-3.rst
@@ -15,7 +15,7 @@ To upload and run a new bootloader the device can be put into USB-downloader
 mode by the SOC microcode when Vol+ is pressed during startup. A new USB
 device "SE Blank RINGO" should appear, barebox may be uploaded using
 
-::
+.. code-block:: console
 
         $ scripts/imx/imx-usb-loader barebox.imximg
 
@@ -26,7 +26,9 @@ imx-usb-loader)
 Barebox may be used as drop-in replacement for the shipped bootloader.
 When installing the barebox imximg on the eMMC take care not to overwrite
 the partition table and vendor supplied serial numbers stored on the eMMC.
-e.g. just write the imx-header and the application section::
+e.g. just write the imx-header and the application section:
+
+.. code-block:: sh
 
         memcpy -b -s barebox.imximg -d /dev/disk0.imx_header 1024 0 1024
         memcpy -b -s barebox.imximg -d /dev/disk0.self 4096 0 195584
diff --git a/Documentation/boards/imx/garz-fricke-vincell.rst b/Documentation/boards/imx/garz-fricke-vincell.rst
index 09d87d67c3..4127c8bc8c 100644
--- a/Documentation/boards/imx/garz-fricke-vincell.rst
+++ b/Documentation/boards/imx/garz-fricke-vincell.rst
@@ -38,6 +38,8 @@ If the network setup is working properly, barebox can be loaded into memory::
   load -v -r -b 0x80100000 barebox-guf-vincell-lt.img
   exec
 
-Once in barebox, the bootloader can now be persisted to NAND::
+Once in barebox, the bootloader can now be persisted to NAND:
+
+.. code-block:: sh
 
   barebox_update -t nand /mnt/tftp/barebox-guf-vincell-lt.img``
diff --git a/Documentation/boards/imx/phytec-phycore-i.mx31.rst b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
index d9a981b998..0feb22257a 100644
--- a/Documentation/boards/imx/phytec-phycore-i.mx31.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
@@ -26,11 +26,15 @@ Supported baseboards are:
 How to get barebox for Phytec's phyCORE-i.MX31
 ----------------------------------------------
 
-Using the default configuration::
+Using the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm pcm037_defconfig
 
-Build the binary image::
+Build the binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
diff --git a/Documentation/boards/mips/dlink-dir-320.rst b/Documentation/boards/mips/dlink-dir-320.rst
index 74d11ffe59..7595381f55 100644
--- a/Documentation/boards/mips/dlink-dir-320.rst
+++ b/Documentation/boards/mips/dlink-dir-320.rst
@@ -26,7 +26,9 @@ Put your barebox.bin to tftp-server directory
 Connect your DIR-320 to your tftp-server network via
 one of four <LAN> sockets.
 
-Next, setup network on DIR-320 and run barebox.bin, e.g.::
+Next, setup network on DIR-320 and run barebox.bin, e.g.:
+
+.. code-block:: console
 
   CFE> ifconfig eth0 -addr=192.168.0.99
   CFE> boot -tftp -addr=a0800000 -raw 192.168.0.1:barebox.bin
diff --git a/Documentation/boards/mips/qemu-malta.rst b/Documentation/boards/mips/qemu-malta.rst
index 0c4d639194..2bb81350a1 100644
--- a/Documentation/boards/mips/qemu-malta.rst
+++ b/Documentation/boards/mips/qemu-malta.rst
@@ -4,7 +4,9 @@ QEMU Malta
 Big-endian mode
 ---------------
 
-QEMU run string::
+QEMU run string:
+
+.. code-block:: sh
 
   qemu-system-mips -nodefaults -M malta -m 256 \
       -nographic -serial stdio -monitor null \
@@ -18,13 +20,17 @@ Running little-endian Malta is a bit tricky.
 In little-endian mode the 32bit words in the boot flash image are swapped,
 a neat trick which allows bi-endian firmware.
 
-You have to swap words of ``zbarebox.bin`` image, e.g.::
+You have to swap words of ``zbarebox.bin`` image, e.g.:
+
+.. code-block:: sh
 
   echo arch/mips/pbl/zbarebox.bin \
       | cpio --create \
       | cpio --extract --swap --unconditional
 
-QEMU run string::
+QEMU run string:
+
+.. code-block:: sh
 
   qemu-system-mipsel -nodefaults -M malta -m 256 \
       -nographic -serial stdio -monitor null \
@@ -39,7 +45,9 @@ You can use GXemul to run little-endian barebox (use gxemul-malta_defconfig).
 
 N.B. There is no need to swap words in ``zbarebox.bin`` for little-endian GXemul!
 
-GXemul run string::
+GXemul run string:
+
+.. code-block:: sh
 
   gxemul -Q -e malta -M 256 0xbfc00000:barebox-flash-image
 
diff --git a/Documentation/boards/mvebu.rst b/Documentation/boards/mvebu.rst
index e27aa28306..9c99c815de 100644
--- a/Documentation/boards/mvebu.rst
+++ b/Documentation/boards/mvebu.rst
@@ -14,7 +14,9 @@ RAM initialisation
 ------------------
 
 Traditionally the RAM initialisation happens with a binary blob that have to be
-extracted from the vendor U-Boot::
+extracted from the vendor U-Boot:
+
+.. code-block:: sh
 
   scripts/kwbimage -x -i /dev/mtdblock0 -o .
 
diff --git a/Documentation/boards/mxs/Chumby-Falconwing.rst b/Documentation/boards/mxs/Chumby-Falconwing.rst
index 172d6840cf..690ccadf8c 100644
--- a/Documentation/boards/mxs/Chumby-Falconwing.rst
+++ b/Documentation/boards/mxs/Chumby-Falconwing.rst
@@ -20,11 +20,15 @@ Memory layout when barebox is running:
 How to get the bootloader binary image
 --------------------------------------
 
-Using the default configuration::
+Using the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm chumbyone_defconfig
 
-Build the bootloader binary image::
+Build the bootloader binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
diff --git a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
index cb73ec1279..077ab73bda 100644
--- a/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
+++ b/Documentation/boards/mxs/Freescale-i.MX23-evk.rst
@@ -19,11 +19,15 @@ Memory layout when barebox is running:
 How to get the bootloader binary image
 --------------------------------------
 
-Using the default configuration::
+Using the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm freescale-mx23-evk_defconfig
 
-Build the bootloader binary image::
+Build the bootloader binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
diff --git a/Documentation/boards/mxs/KaRo-TX28.rst b/Documentation/boards/mxs/KaRo-TX28.rst
index 6cad5eb243..54b1ce71eb 100644
--- a/Documentation/boards/mxs/KaRo-TX28.rst
+++ b/Documentation/boards/mxs/KaRo-TX28.rst
@@ -24,11 +24,15 @@ Supported baseboards are:
 How to get barebox for 'KARO's Starterkit 5'
 --------------------------------------------
 
-Using the default configuration::
+Using the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm tx28stk5_defconfig
 
-Build the binary image::
+Build the binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
diff --git a/Documentation/boards/mxs/Olimex-olinuxino.rst b/Documentation/boards/mxs/Olimex-olinuxino.rst
index a06eb3309f..2080653887 100644
--- a/Documentation/boards/mxs/Olimex-olinuxino.rst
+++ b/Documentation/boards/mxs/Olimex-olinuxino.rst
@@ -9,11 +9,15 @@ This CPU module is based on a Freescale i.MX23 CPU.
 How to get the bootloader binary image
 --------------------------------------
 
-Using the default configuration::
+Using the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm imx233-olinuxino_defconfig
 
-Build the binary image::
+Build the binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
diff --git a/Documentation/boards/omap.rst b/Documentation/boards/omap.rst
index c2697510c5..717a38fe01 100644
--- a/Documentation/boards/omap.rst
+++ b/Documentation/boards/omap.rst
@@ -15,7 +15,9 @@ The PandaBoard boots from SD card. The OMAP Boot ROM code loads a file named
 scripts on the net which describe how to prepare such a card (it needs
 special partitioning). The same procedure can be used for barebox. With such a
 card (assumed to be at /dev/sdc), the following can be used to build and install
-barebox::
+barebox:
+
+.. code-block:: console
 
   # mount -t fat /dev/sdc1 /mnt
   # make panda_xload_defconfig
diff --git a/Documentation/boards/openrisc.rst b/Documentation/boards/openrisc.rst
index fe6c48c958..f9d67f9650 100644
--- a/Documentation/boards/openrisc.rst
+++ b/Documentation/boards/openrisc.rst
@@ -4,7 +4,9 @@ OpenRISC
 or1ksim
 -------
 
-Compile or1ksim emulator::
+Compile or1ksim emulator:
+
+.. code-block:: console
 
  $ cd ~/
  $ git clone https://github.com/openrisc/or1ksim
@@ -48,6 +50,8 @@ Create minimal or1ksim.cfg file:
    tap_dev = "tap0"
  end
 
-Run or1ksim::
+Run or1ksim:
+
+.. code-block:: console
 
  $ ~/or1ksim/sim -f or1ksim.cfg barebox
diff --git a/Documentation/boards/s3c/Digi-a9m2440.rst b/Documentation/boards/s3c/Digi-a9m2440.rst
index d01a001172..32d58b9a04 100644
--- a/Documentation/boards/s3c/Digi-a9m2440.rst
+++ b/Documentation/boards/s3c/Digi-a9m2440.rst
@@ -78,11 +78,15 @@ This CPU card is based on a Samsung S3C2440 CPU. The card is shipped with:
 How to get the binary image
 ---------------------------
 
-Configure with the default configuration::
+Configure with the default configuration:
+
+.. code-block:: sh
 
   make ARCH=arm a9m2440_defconfig
 
-Build the binary image::
+Build the binary image:
+
+.. code-block:: sh
 
   make ARCH=arm CROSS_COMPILE=armv4compiler
 
diff --git a/Documentation/boards/sandbox.rst b/Documentation/boards/sandbox.rst
index 558f111697..85a54e6b04 100644
--- a/Documentation/boards/sandbox.rst
+++ b/Documentation/boards/sandbox.rst
@@ -7,7 +7,9 @@ hardware related features.
 Building barebox for simulation
 -------------------------------
 
-The barebox sandbox can be built with the host compiler::
+The barebox sandbox can be built with the host compiler:
+
+.. code-block:: sh
 
   ARCH=sandbox make sandbox_defconfig
   ARCH=sandbox make
@@ -17,6 +19,8 @@ Running the sandbox
 
 Once you compile barebox for the sandbox, you can run it with::
 
+.. code-block:: console
+
   $ barebox [<OPTIONS>]
 
 Available sandbox invocation options include:
diff --git a/Documentation/boards/socfpga.rst b/Documentation/boards/socfpga.rst
index cd0fffa1ee..d73237491d 100644
--- a/Documentation/boards/socfpga.rst
+++ b/Documentation/boards/socfpga.rst
@@ -41,7 +41,9 @@ second partition of the SD card, which must be of type FAT32. On this partition
 barebox searches for a file called barebox.bin.
 
 To boot barebox on a Terasic SoCkit, the procedure is as follows (sdb1 is the A2 and
-sdb2 the FAT32 partition)::
+sdb2 the FAT32 partition):
+
+.. code-block:: sh
 
   mount -t fat /dev/sdb2 /mnt
   make socfpga-xload_defconfig
@@ -50,7 +52,9 @@ sdb2 the FAT32 partition)::
   make
 
 barebox has now generated multiple files in the images directory. So for the SoCkit
-proceed with::
+proceed with:
+
+.. code-block:: sh
 
   cat images/barebox-socfpga-sockit-xload.img > /dev/sdb1
   cp images/barebox-socfpga-sockit.img /mnt/barebox.bin
@@ -64,12 +68,16 @@ QSPI
 The Boot ROM loads the preloader starting from address 0x0 on the QSPI flash.
 barebox then searches for a barebox image at the 256K offset and loads it.
 
-The default bootsource is SD card, so to change that to QSPI, you have to::
+The default bootsource is SD card, so to change that to QSPI, you have to:
+
+.. code-block:: sh
 
   make socfpga-xload_defconfig
   make menuconfig
 
-And then select the options `MTD` and `SPI_CADENCE_QUADSPI`. Now::
+And then select the options `MTD` and `SPI_CADENCE_QUADSPI`. Now:
+
+.. code-block:: sh
 
   make
   cat images/barebox-socfpga-<board>-xload.img > /dev/mtd0
@@ -116,7 +124,9 @@ To update the handoff files, the following procedure is necessary:
    preloader settings directory
 7. Click ``Ok`` than ``Generate``
 
-Now run the command::
+Now run the command:
+
+.. code-block:: sh
 
   scripts/socfpga_import_preloader <SPL_GENERATED_DIR> <ISW_HANDOFF> <BOARD_DIRECTORY>
 
@@ -141,7 +151,9 @@ tree:
 * system.h
 * tclrpt.h
 
-To add these files, run::
+To add these files, run:
+
+.. code-block:: sh
 
   scripts/socfpga_get_sequencer <UBOOT-SRC> scripts/socfpga_sequencer_defines_defaults
 
diff --git a/Documentation/boards/x86.rst b/Documentation/boards/x86.rst
index d0528a3280..4514a766a2 100644
--- a/Documentation/boards/x86.rst
+++ b/Documentation/boards/x86.rst
@@ -50,7 +50,8 @@ sectors must be kept free after the MBR prior the first partition. Do this
 simple calulation:
 
 .. code-block:: none
-  sectors = (\<size of barebox image\> + 511) / 512
+
+  sectors = (size of barebox image + 511) / 512
 
 To be able to store the runtime configuration, further free sectors are
 required. Its up to you and your requirements, how large this persistant