add add_help_text command handler
[openocd.git] / src / helper / startup.tcl
index eefb690eee9a0a35be62851050d8750ab5055258..fc84943a5d3891056ba55b4e57b09efa4f30eb19 100644 (file)
@@ -3,21 +3,6 @@
 # Embedded into OpenOCD executable
 #
 
-# Help text list. A list of command + help text pairs.
-#
-# Commands can be more than one word and they are stored
-# as "flash banks" "help text x x x"
-
-proc add_help_text {cmd cmd_help} {
-       global ocd_helptext
-       lappend ocd_helptext [list $cmd $cmd_help]
-}
-
-proc get_help_text {} {
-       global ocd_helptext
-       return $ocd_helptext
-}
-
 
 # We need to explicitly redirect this to the OpenOCD command
 # as Tcl defines the exit proc
@@ -25,51 +10,40 @@ proc exit {} {
        ocd_throw exit
 }
 
-#Print help text for a command. Word wrap
-#help text that is too wide inside column.
-proc help {args} {
-       global ocd_helptext
-       set cmd $args
-       foreach a [lsort $ocd_helptext] {
-               if {[string length $cmd] == 0 || \
-                       [string first $cmd $a] != -1 || \
-                       [string first $cmd [lindex $a 1]] != -1} \
-               {
-                       set w 50
-                       set cmdname [lindex $a 0]
-                       set h [lindex $a 1]
-                       set n 0
-                       while 1 {
-                               if {$n > [string length $h]} {break}
+# Help text list. A list of command + help text pairs.
+proc cmd_help {cmdname h indent} {
+       set indent [expr $indent * 2]
+
+       set fmt_str [format "%%%ds%%-%ds %%s" $indent [expr 25 - $indent]]
+       set w [expr 50 - $indent]
+       set n 0
 
-                               set next_a [expr $n + $w]
-                               if {[string length $h] > $n + $w} \
-                               {
-                                       set xxxx [string range $h $n [expr $n + $w]]
-                                       for {set lastpos [expr [string length $xxxx] - 1]} \
-                                               {$lastpos >= 0 && [string compare \
-                                                       [string range $xxxx $lastpos $lastpos] " "] != 0} \
-                                               {set lastpos [expr $lastpos - 1]} \
-                                       {
-                                       }
-                                       #set next_a -1
-                                       if {$lastpos != -1} {
-                                               set next_a [expr $lastpos + $n + 1]
-                                       }
-                               }
+       while 1 {
+               if {$n > [string length $h]} {break}
 
-                               puts [format "%-25s %s" $cmdname \
-                                               [string range $h $n [expr $next_a-1]] ]
-                               set cmdname ""
-                               set n [expr $next_a]
+               set next_a [expr $n + $w]
+               if {[string length $h] > $n + $w} \
+               {
+                       set xxxx [string range $h $n [expr $n + $w]]
+                       for {set lastpos [expr [string length $xxxx] - 1]} \
+                               {$lastpos >= 0 && [string compare \
+                                       [string range $xxxx $lastpos $lastpos] " "] != 0} \
+                               {set lastpos [expr $lastpos - 1]} \
+                       {
+                       }
+                       #set next_a -1
+                       if {$lastpos != -1} {
+                               set next_a [expr $lastpos + $n + 1]
                        }
                }
+
+               puts [format $fmt_str "" $cmdname \
+                               [string range $h $n [expr $next_a - 1]] ]
+               set cmdname ""
+               set n [expr $next_a]
        }
 }
 
-add_help_text help "Tcl implementation of help command"
-
-
 # If a fn is unknown to Tcl, we try to execute it as an OpenOCD command
 #
 # We also support two level commands. "flash banks" is translated to

Linking to existing account procedure

If you already have an account and want to add another login method you MUST first sign in with your existing account and then change URL to read https://review.openocd.org/login/?link to get to this page again but this time it'll work for linking. Thank you.

SSH host keys fingerprints

1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=..              |
|+o..   .         |
|*.o   . .        |
|+B . . .         |
|Bo. = o S        |
|Oo.+ + =         |
|oB=.* = . o      |
| =+=.+   + E     |
|. .=o   . o      |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)