[PATCH 1/3] fixup! Documentation: Add zii-vf610-dev board documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Roland Hieber <rhi@xxxxxxxxxxxxxx>
---
Hi Sascha, Andrey,

Yay, documentation patches \o/

Here are three small fixups:
- Improve some typos and missing articles.
- Break long shell lines for better readability.
- Don't use <variable> syntax for placeholders in shell command lines,
  which could be misinterpreted as shell redirection operators.
---
 .../boards/imx/zii-vf610-dev/readme.rst         | 17 +++++++++--------
 1 file changed, 9 insertions(+), 8 deletions(-)

diff --git a/Documentation/boards/imx/zii-vf610-dev/readme.rst b/Documentation/boards/imx/zii-vf610-dev/readme.rst
index 9418a3a278f0..08ae0e0e6760 100644
--- a/Documentation/boards/imx/zii-vf610-dev/readme.rst
+++ b/Documentation/boards/imx/zii-vf610-dev/readme.rst
@@ -23,11 +23,12 @@ follows:
   cd barebox
   Documentation/boards/imx/zii-vf610-dev/bootstrap.sh
 
-custom OpenOCD binary and options can be specified as follows:
+A custom OpenOCD binary and options can be specified as follows:
 
 .. code-block:: sh
 
-  OPENOCD="../openocd/src/openocd -s ../openocd/tcl " Documentation/boards/imx/zii-vf610-dev/bootstrap.sh
+  OPENOCD="../openocd/src/openocd -s ../openocd/tcl " \
+    Documentation/boards/imx/zii-vf610-dev/bootstrap.sh
 
 Writing Barebox to NVM
 ----------------------
@@ -37,14 +38,14 @@ come with eMMC. To permanently write Barebox to it do:
 
 .. code-block:: sh
 
-  barebox_update -t eMMC -y <barebox.img>
+  barebox_update -t eMMC -y barebox.img
 
-This should also automaticaly configure your board to boot that
-image. Note that original ZII stack's bootloader in eMMC should be
-left intact. Barebox is configured to be programmed to one of MMC boot
-partitions, whereas original bootloader is located in user partition.
+This should also automatically configure your board to boot that
+image. Note that the original ZII stack's bootloader in eMMC should be
+left intact. Barebox is configured to be programmed to one of the MMC boot
+partitions, whereas the original bootloader is located in user partition.
 
-To restore the board to booting using original bootloader do:
+To restore the board to booting using the original bootloader do:
 
 .. code-block:: sh
 
-- 
2.20.1


_______________________________________________
barebox mailing list
barebox@xxxxxxxxxxxxxxxxxxx
http://lists.infradead.org/mailman/listinfo/barebox



[Index of Archives]     [Linux Embedded]     [Linux USB Devel]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [XFree86]

  Powered by Linux