From 1cdef63264db6003e47abd6a57f5260db40d6830 Mon Sep 17 00:00:00 2001
From: Gregory Nutt <gnutt@nuttx.org>
Date: Sat, 18 Jan 2014 10:20:22 -0600
Subject: NSH: Improved documentation of the break command

---
 apps/nshlib/README.txt | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'apps')

diff --git a/apps/nshlib/README.txt b/apps/nshlib/README.txt
index cdf7600bf..3d57b7bd2 100644
--- a/apps/nshlib/README.txt
+++ b/apps/nshlib/README.txt
@@ -117,12 +117,12 @@ Looping
         Execute <cmd-sequence> as long as <test-cmd> has an exit status of
         zero.
 
-     until <test-cmd>; do <cmd-sequence>; done
+    until <test-cmd>; do <cmd-sequence>; done
 
         Execute <cmd-sequence> as long as <test-cmd> has a non-zero exit
         status.
 
-  A break command is also supported.  The break command is only valid
+  A break command is also supported.  The break command is only meaningful
   within the body of the a while or until loop, between the do and done
   tokens. If the break command is executed within the body of a loop, the
   loop will immediately terminate and execution will continue with the
@@ -301,6 +301,14 @@ o base64dec [-w] [-f] <string or filepath>
 
 o base64dec [-w] [-f] <string or filepath>
 
+o break
+
+  The break command is only meaningful within the body of the a while or
+  until loop, between the do and done tokens. Outside of a loop, break
+  command does nothing. If the break command is executed within the body
+  of a loop, the loop will immediately terminate and execution will
+  continue with the next command immediately following the done token. 
+
 o cat <path> [<path> [<path> ...]]
 
   This command copies and concatenates all of the files at <path>
-- 
cgit v1.2.3