Merge branch 'for-next/doc'

13 files changed, 51 insertions, 34 deletions

diff --git a/Documentation/boards/imx/amazon-kindle3.rst b/Documentation/boards/imx/amazon-kindle-3.rst
index 50592f2cb9..dffb7efb2d 100644
--- a/Documentation/boards/imx/amazon-kindle3.rst
+++ b/Documentation/boards/imx/amazon-kindle-3.rst
@@ -14,7 +14,10 @@ vendor modified u-boot imximage.
 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
-$ scripts/imx/imx-usb-loader barebox.imximg
+
+::
+
+        $ scripts/imx/imx-usb-loader barebox.imximg
 
 Note: a USB serial ACM console will be launched by a barebox init script
 when the cursor select key is pressed during startup (e.g. before running
@@ -23,6 +26,7 @@ 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:
-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
+e.g. just write the imx-header and the application section::
+
+        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/amazon-kindle-mx50.rst b/Documentation/boards/imx/amazon-kindle-4-5.rst
index 1e71cd26ba..bc6bf2609b 100644
--- a/Documentation/boards/imx/amazon-kindle-mx50.rst
+++ b/Documentation/boards/imx/amazon-kindle-4-5.rst
@@ -18,24 +18,32 @@ are shipped with a vendor modified u-boot imximage based on u-boot v2009.08.
 To upload and run a new bootloader the older devices can be put into
 USB-downloader mode by the SOC microcode when a specific key is pressed during
 startup:
+
 * the fiveway down button on the model D01100
 * the home button on model D01200
+
 A new USB device "NS Blank CODEX" should appear, barebox may be uploaded using
-$ scripts/imx/imx-usb-loader barebox-kindle-d01100.img
-$ scripts/imx/imx-usb-loader barebox-kindle-d01200.img
+
+::
+
+        $ scripts/imx/imx-usb-loader barebox-kindle-d01100.img
+        $ scripts/imx/imx-usb-loader barebox-kindle-d01200.img
+
 Hint: keep the select button pressed down to get the barebox USB console.
 
 Barebox may be used as drop-in replacement for the shipped bootloader, when
 the imximg fits into 258048 bytes. When installing the barebox imximg on
-the eMMC take care not to overwrite the vendor supplied serial numbers stored
-on the eMMC.
-e.g. for the D01100 just write the imx-header and the application section:
-loady -t usbserial
-memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.imx_header 1024 0 2048
-memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.self 4096 0 253952
+the eMMC, take care not to overwrite the vendor supplied serial numbers stored
+on the eMMC,
+e.g. for the D01100 just write the imx-header and the application section::
+
+        loady -t usbserial
+        memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.imx_header 1024 0 2048
+        memcpy -b -s barebox-kindle-d01100.img -d /dev/disk0.boot0.self 4096 0 253952
 
 Note: a USB serial ACM console will be launched by a barebox init script
 when
+
 * the cursor select key is pressed during startup of model D01100
 * the home button is pressed within a second after startup of model D01200.
   If you press the home button during startup, you will enter USB boot mode.
@@ -47,12 +55,15 @@ power consumption to a few milliamps of battery power, after some minutes
 the power consumption is further reduced to about 550 microamps. Switching
 on iomux pullups may significantly reduce your standby-time.
 
-Hints to reduce the build image size.
+Hints to reduce the build image size
+------------------------------------
+
 Note that a drop-in replacement barebox imximage must not exceed 258048 bytes
 since the space behind it is in use. Hence, don't build in drivers and FS
-that are not required, e.g.:
-  NET, DISK_AHCI, DISK_INTF_PLATFORM_IDE, DISK_ATA, VIDEO, PWM, LED,
-  USB_STORAGE, USB_ULPI, NAND, MTD_UBI, FS_UBIFS, MFD_MC34704, MFD_MC9SDZ60,
-  MFD_STMPE, EEPROM_AT25, EEPROM_AT24, KEYBOARD_GPIO, PARTITION_DISK_EFI
+that are not required, e.g.
+``NET, DISK_AHCI, DISK_INTF_PLATFORM_IDE, DISK_ATA, VIDEO, PWM, LED,
+USB_STORAGE, USB_ULPI, NAND, MTD_UBI, FS_UBIFS, MFD_MC34704, MFD_MC9SDZ60,
+MFD_STMPE, EEPROM_AT25, EEPROM_AT24, KEYBOARD_GPIO, PARTITION_DISK_EFI``
+
 Also unselect support for other boards to get rid of their dependencies.
-Further select IMAGE_COMPRESSION_XZKERN
+Further select ``IMAGE_COMPRESSION_XZKERN``.
diff --git a/Documentation/boards/imx/Element14-WaRP7.rst b/Documentation/boards/imx/element14-warp7.rst
index df14f84dc4..830a2fb55b 100644
--- a/Documentation/boards/imx/Element14-WaRP7.rst
+++ b/Documentation/boards/imx/element14-warp7.rst
@@ -4,15 +4,16 @@ element14 WaRP7
 This CPU card is based on an NXP i.MX7S SoC.
 
 Supported hardware
-==================
+------------------
 
 - NXP PMIC PFUZE3000
 - Kingston 08EMCP04-EL3AV100 eMCP (eMMC and LPDDR3 memory in one package)
+
   - 8 GiB eMMC Triple-Level cell NAND flash, eMMC standard 5.0 (HS400)
   - 512 MiB LPDDR3 SDRAM starting at address 0x80000000
 
 Bootstrapping barebox
-=====================
+---------------------
 
 The device boots in internal boot mode from eMMC and is shipped with a
 vendor modified u-boot imximage.
diff --git a/Documentation/boards/imx/Garz-Fricke-Cupid.rst b/Documentation/boards/imx/garz-fricke-cupid.rst
index 452004859e..452004859e 100644
--- a/Documentation/boards/imx/Garz-Fricke-Cupid.rst
+++ b/Documentation/boards/imx/garz-fricke-cupid.rst
diff --git a/Documentation/boards/imx/Garz-Fricke-Vincell.rst b/Documentation/boards/imx/garz-fricke-vincell.rst
index 58ab0ab42f..09d87d67c3 100644
--- a/Documentation/boards/imx/Garz-Fricke-Vincell.rst
+++ b/Documentation/boards/imx/garz-fricke-vincell.rst
@@ -7,11 +7,11 @@ This CPU card is based on a Freescale i.MX53 CPU. The card is shipped with:
   * 512MiB synchronous dynamic RAM
   * microSD slot
 
-see http://www.garz-fricke.com/en/products/embedded-systems/single-board-computer/ia-0086r/ for more information
+See http://www.garz-fricke.com/en/products/embedded-systems/single-board-computer/ia-0086r/ for more information.
 
 
 Bootstrapping barebox
-=====================
+---------------------
 
 The Vincell is shipped with the RedBoot bootloader. To replace RedBoot with
 barebox, you first need to connect a serial console to the device.
diff --git a/Documentation/boards/imx/Karo-TX25.rst b/Documentation/boards/imx/karo-tx25.rst
index 756c99d816..756c99d816 100644
--- a/Documentation/boards/imx/Karo-TX25.rst
+++ b/Documentation/boards/imx/karo-tx25.rst
diff --git a/Documentation/boards/imx/Karo-TX6.rst b/Documentation/boards/imx/karo-tx6.rst
index 8dd26b5964..acd6d68eeb 100644
--- a/Documentation/boards/imx/Karo-TX6.rst
+++ b/Documentation/boards/imx/karo-tx6.rst
@@ -1,5 +1,5 @@
-KaRo TX6x
-=========
+Ka-Ro TX6x
+==========
 
 This CPU cards are based on a Freescale i.MX6 SoC.
 There are currently six variants of this module, that are distinguished
diff --git a/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst b/Documentation/boards/imx/phytec-phycard-i.mx27.rst
index d5d3837132..d5d3837132 100644
--- a/Documentation/boards/imx/Phytec-phyCARD-i.MX27.rst
+++ b/Documentation/boards/imx/phytec-phycard-i.mx27.rst
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst b/Documentation/boards/imx/phytec-phycore-i.mx27.rst
index 4b40be781d..4b40be781d 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX27.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx27.rst
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
index 6c05bcdfdc..d9a981b998 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX31.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx31.rst
@@ -23,8 +23,8 @@ Supported baseboards
 Supported baseboards are:
   * Silica / Phytec PCM-970 via phyMAP-i.MX31, PMA-001
 
-How to get barebox for 'Phytec's phyCORE-i.MX31'
-------------------------------------------------
+How to get barebox for Phytec's phyCORE-i.MX31
+----------------------------------------------
 
 Using the default configuration::
 
@@ -34,8 +34,8 @@ Build the binary image::
 
   make ARCH=arm CROSS_COMPILE=armv5compiler
 
-**NOTE:** replace ''armv5compiler'' with your ARM v5 cross compiler,
- e.g.: ''arm-1136jfs-linux-gnueabi-''
+.. note:: replace ``armv5compiler`` with your ARM v5 cross compiler prefix,
+ e.g.: ``arm-1136jfs-linux-gnueabi-``
 
 The resulting binary image to be flashed will be ``barebox.bin``, whereas
 the file named just ``barebox`` is an ELF executable for ARM.
diff --git a/Documentation/boards/imx/Phytec-phyCORE-i.MX35.rst b/Documentation/boards/imx/phytec-phycore-i.mx35.rst
index adf5d26382..adf5d26382 100644
--- a/Documentation/boards/imx/Phytec-phyCORE-i.MX35.rst
+++ b/Documentation/boards/imx/phytec-phycore-i.mx35.rst
diff --git a/Documentation/boards/imx/synertronixx_scb9328.rst b/Documentation/boards/imx/synertronixx_scb9328.rst
index 0e59046a24..a104d1c2f7 100644
--- a/Documentation/boards/imx/synertronixx_scb9328.rst
+++ b/Documentation/boards/imx/synertronixx_scb9328.rst
@@ -1,4 +1,4 @@
-Synertronixx scb9328
+Synertronixx SCB9328
 ====================
 
 See http://www.synertronixx.de/produkte/scb9328/scb9328.htm
diff --git a/Documentation/boards/imx/Wandboard.rst b/Documentation/boards/imx/wandboard.rst
index 574318a009..8283b47260 100644
--- a/Documentation/boards/imx/Wandboard.rst
+++ b/Documentation/boards/imx/wandboard.rst
@@ -8,14 +8,15 @@ the Wandboard Dual (i.MX6DL, 1GiB DDR3) and Wandboard Quad (i.MX6Q, 2GiB DDR3).
 The device boots from the SD card slot on the System-on-Module board, it
 will not boot from the slot on the carrier board.
 
-To boot barebox on any wandboard, build imx_v7_defconfig
-and copy the barebox imx-image to the i.MX boot location of a SD card, e.g.
-dd bs=1024 skip=1 seek=1 if=images/barebox-imx6-wandboard.img of=/dev/mmcblk0
+To boot barebox on any wandboard, build ``imx_v7_defconfig``
+and copy the barebox imx-image to the i.MX boot location of a SD card, e.g.::
+
+        dd bs=1024 skip=1 seek=1 if=images/barebox-imx6-wandboard.img of=/dev/mmcblk0
 
 Only one image exists, supporting all three Wandboard variants, barebox will
 detect the Wandboard variant depending on the SoC variant.
-This image is only usable for SD-boot. It will not boot via imx-usb-loader.
+This image is only usable for SD boot. It will not boot via imx-usb-loader.
 
 Connect to the serial port using a null-modem cable to get console access.
 
-For further documentation, including board schematics see http://wandboard.org/
+For further documentation, including board schematics, see http://wandboard.org/.