summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2010-01-02 15:52:35 -0800
committerDavid Brownell <dbrownell@users.sourceforge.net>2010-01-02 15:52:35 -0800
commitb3bf1d12b2fdfba1c1cbee3e1afbfbb27cbd1a26 (patch)
tree41b3da25e64baedc94156b296b8626fec55844b2 /doc
parent9d167d62f2eadf81e0028e471e05154c9aabbbfb (diff)
downloadopenocd+libswd-b3bf1d12b2fdfba1c1cbee3e1afbfbb27cbd1a26.tar.gz
openocd+libswd-b3bf1d12b2fdfba1c1cbee3e1afbfbb27cbd1a26.tar.bz2
openocd+libswd-b3bf1d12b2fdfba1c1cbee3e1afbfbb27cbd1a26.tar.xz
openocd+libswd-b3bf1d12b2fdfba1c1cbee3e1afbfbb27cbd1a26.zip
streamline and document helptext mode displays
Most commands are usable only at runtime; so don't bother saying that, it's noise. Moreover, tokens like EXEC are cryptic. Be more clear: highlight only the commands which may (also) be used during the config stage, thus matching the docs more closely. There are - Configuration commands (per documentation) - And also some commands that valid at *any* time. Update the docs to note that "help" now shows this mode info. This also highlighted a few mistakes in command configuration, mostly commands listed as "valid at any time" which shouldn't have been. This just fixes ones I noted when sanity testing. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi13
1 files changed, 10 insertions, 3 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index cc0edf8d..3f5882ce 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -1630,9 +1630,14 @@ supported.
When the OpenOCD server process starts up, it enters a
@emph{configuration stage} which is the only time that
certain commands, @emph{configuration commands}, may be issued.
+Normally, configuration commands are only available
+inside startup scripts.
+
In this manual, the definition of a configuration command is
presented as a @emph{Config Command}, not as a @emph{Command}
which may be issued interactively.
+The runtime @command{help} command also highlights configuration
+commands, and those which may be issued at any time.
Those configuration commands include declaration of TAPs,
flash banks,
@@ -5093,13 +5098,15 @@ port is 5555.
Exits the current telnet session.
@end deffn
-@c note EXTREMELY ANNOYING word wrap at column 75
-@c even when lines are e.g. 100+ columns ...
-@c coded in startup.tcl
@deffn {Command} help [string]
With no parameters, prints help text for all commands.
Otherwise, prints each helptext containing @var{string}.
Not every command provides helptext.
+
+Configuration commands, and commands valid at any time, are
+explicitly noted in parenthesis.
+In most cases, no such restriction is listed; this indicates commands
+which are only available after the configuration stage has completed.
@end deffn
@deffn Command sleep msec [@option{busy}]