summaryrefslogtreecommitdiff
path: root/apps/nshlib
diff options
context:
space:
mode:
authorGregory Nutt <gnutt@nuttx.org>2014-01-18 10:20:22 -0600
committerGregory Nutt <gnutt@nuttx.org>2014-01-18 10:20:22 -0600
commit1cdef63264db6003e47abd6a57f5260db40d6830 (patch)
tree9ddffb92b090b88e51a193cca2ac4e902e7b8175 /apps/nshlib
parentc9e72e0eed21a1c8c679bc094b0960dabf31c84d (diff)
downloadnuttx-1cdef63264db6003e47abd6a57f5260db40d6830.tar.gz
nuttx-1cdef63264db6003e47abd6a57f5260db40d6830.tar.bz2
nuttx-1cdef63264db6003e47abd6a57f5260db40d6830.zip
NSH: Improved documentation of the break command
Diffstat (limited to 'apps/nshlib')
-rw-r--r--apps/nshlib/README.txt12
1 files changed, 10 insertions, 2 deletions
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>