Skip to content

Commit 98c95df

Browse files
zapb-0borneoa
authored andcommitted
doc/openocd: Fix Tcl spelling
Use 'Tcl' because it is the official spelling. While at it, fix some misspellings of 'Jim Tcl'. Change-Id: I084541a1cc0276d15a263b843ba740da04efc30a Signed-off-by: Marc Schink <[email protected]> Reviewed-on: https://review.openocd.org/c/openocd/+/8852 Tested-by: jenkins Reviewed-by: Antonio Borneo <[email protected]>
1 parent 639b743 commit 98c95df

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

doc/openocd.texi

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Documentation License''.
6262
* About:: About OpenOCD
6363
* Developers:: OpenOCD Developer Resources
6464
* Debug Adapter Hardware:: Debug Adapter Hardware
65-
* About Jim-Tcl:: About Jim-Tcl
65+
* About Jim Tcl:: About Jim Tcl
6666
* Running:: Running OpenOCD
6767
* OpenOCD Project Setup:: OpenOCD Project Setup
6868
* Config File Guidelines:: Config File Guidelines
@@ -629,43 +629,43 @@ This is deprecated from Linux v5.3; prefer using @b{linuxgpiod}.
629629

630630
@end itemize
631631

632-
@node About Jim-Tcl
633-
@chapter About Jim-Tcl
634-
@cindex Jim-Tcl
632+
@node About Jim Tcl
633+
@chapter About Jim Tcl
634+
@cindex Jim Tcl
635635
@cindex tcl
636636

637-
OpenOCD uses a small ``Tcl Interpreter'' known as Jim-Tcl.
637+
OpenOCD uses a small ``Tcl Interpreter'' known as Jim Tcl.
638638
This programming language provides a simple and extensible
639639
command interpreter.
640640

641-
All commands presented in this Guide are extensions to Jim-Tcl.
641+
All commands presented in this Guide are extensions to Jim Tcl.
642642
You can use them as simple commands, without needing to learn
643643
much of anything about Tcl.
644644
Alternatively, you can write Tcl programs with them.
645645

646646
You can learn more about Jim at its website, @url{http://jim.tcl.tk}.
647647
There is an active and responsive community, get on the mailing list
648-
if you have any questions. Jim-Tcl maintainers also lurk on the
648+
if you have any questions. Jim Tcl maintainers also lurk on the
649649
OpenOCD mailing list.
650650

651651
@itemize @bullet
652652
@item @b{Jim vs. Tcl}
653-
@* Jim-Tcl is a stripped down version of the well known Tcl language,
654-
which can be found here: @url{http://www.tcl.tk}. Jim-Tcl has far
655-
fewer features. Jim-Tcl is several dozens of .C files and .H files and
653+
@* Jim Tcl is a stripped down version of the well known Tcl language,
654+
which can be found here: @url{http://www.tcl.tk}. Jim Tcl has far
655+
fewer features. Jim Tcl is several dozens of .C files and .H files and
656656
implements the basic Tcl command set. In contrast: Tcl 8.6 is a
657657
4.2 MB .zip file containing 1540 files.
658658

659659
@item @b{Missing Features}
660660
@* Our practice has been: Add/clone the real Tcl feature if/when
661-
needed. We welcome Jim-Tcl improvements, not bloat. Also there
662-
are a large number of optional Jim-Tcl features that are not
661+
needed. We welcome Jim Tcl improvements, not bloat. Also there
662+
are a large number of optional Jim Tcl features that are not
663663
enabled in OpenOCD.
664664

665665
@item @b{Scripts}
666-
@* OpenOCD configuration scripts are Jim-Tcl Scripts. OpenOCD's
666+
@* OpenOCD configuration scripts are Jim Tcl Scripts. OpenOCD's
667667
command interpreter today is a mixture of (newer)
668-
Jim-Tcl commands, and the (older) original command interpreter.
668+
Jim Tcl commands, and the (older) original command interpreter.
669669

670670
@item @b{Commands}
671671
@* At the OpenOCD telnet command line (or via the GDB monitor command) one
@@ -674,10 +674,10 @@ Some of the commands documented in this guide are implemented
674674
as Tcl scripts, from a @file{startup.tcl} file internal to the server.
675675

676676
@item @b{Historical Note}
677-
@* Jim-Tcl was introduced to OpenOCD in spring 2008. Fall 2010,
678-
before OpenOCD 0.5 release, OpenOCD switched to using Jim-Tcl
679-
as a Git submodule, which greatly simplified upgrading Jim-Tcl
680-
to benefit from new features and bugfixes in Jim-Tcl.
677+
@* Jim Tcl was introduced to OpenOCD in spring 2008. Fall 2010,
678+
before OpenOCD 0.5 release, OpenOCD switched to using Jim Tcl
679+
as a Git submodule, which greatly simplified upgrading Jim Tcl
680+
to benefit from new features and bugfixes in Jim Tcl.
681681

682682
@item @b{Need a crash course in Tcl?}
683683
@*@xref{Tcl Crash Course}.
@@ -796,7 +796,7 @@ those channels.
796796
If you are having problems, you can enable internal debug messages via
797797
the @option{-d} option.
798798

799-
Also it is possible to interleave Jim-Tcl commands w/config scripts using the
799+
Also it is possible to interleave Jim Tcl commands w/config scripts using the
800800
@option{-c} command line switch.
801801

802802
To enable debug output (when reporting problems or working on OpenOCD
@@ -962,7 +962,7 @@ that can be tested in a later script.
962962
@end quotation
963963

964964
Here we will focus on the simpler solution: one user config
965-
file, including basic configuration plus any TCL procedures
965+
file, including basic configuration plus any Tcl procedures
966966
to simplify your work.
967967

968968
@section User Config Files
@@ -1432,7 +1432,7 @@ In addition to target-specific utility code, another way that
14321432
board and target config files communicate is by following a
14331433
convention on how to use certain variables.
14341434

1435-
The full Tcl/Tk language supports ``namespaces'', but Jim-Tcl does not.
1435+
The full Tcl/Tk language supports ``namespaces'', but Jim Tcl does not.
14361436
Thus the rule we follow in OpenOCD is this: Variables that begin with
14371437
a leading underscore are temporary in nature, and can be modified and
14381438
used at will within a target configuration file.
@@ -1552,7 +1552,7 @@ configuration files for other JTAG tools
15521552
Some of this code could probably be shared between different boards.
15531553
For example, setting up a DRAM controller often doesn't differ by
15541554
much except the bus width (16 bits or 32?) and memory timings, so a
1555-
reusable TCL procedure loaded by the @file{target.cfg} file might take
1555+
reusable Tcl procedure loaded by the @file{target.cfg} file might take
15561556
those as parameters.
15571557
Similarly with oscillator, PLL, and clock setup;
15581558
and disabling the watchdog.
@@ -2137,7 +2137,7 @@ corresponding subsystems:
21372137
@end deffn
21382138

21392139
At last, @command{init} executes all the commands that are specified in
2140-
the TCL list @var{post_init_commands}. The commands are executed in the
2140+
the Tcl list @var{post_init_commands}. The commands are executed in the
21412141
same order they occupy in the list. If one of the commands fails, then
21422142
the error is propagated and OpenOCD fails too.
21432143
@example
@@ -2222,7 +2222,7 @@ cause initialization to fail with "Unknown remote qXfer reply: OK".
22222222

22232223
@deffn {Config Command} {tcl port} [number]
22242224
Specify or query the port used for a simplified RPC
2225-
connection that can be used by clients to issue TCL commands and get the
2225+
connection that can be used by clients to issue Tcl commands and get the
22262226
output from the Tcl engine.
22272227
Intended as a machine interface.
22282228
When not specified during the configuration stage,
@@ -2233,7 +2233,7 @@ When specified as "disabled", this service is not activated.
22332233
@deffn {Config Command} {telnet port} [number]
22342234
Specify or query the
22352235
port on which to listen for incoming telnet connections.
2236-
This port is intended for interaction with one human through TCL commands.
2236+
This port is intended for interaction with one human through Tcl commands.
22372237
When not specified during the configuration stage,
22382238
the port @var{number} defaults to 4444.
22392239
When specified as "disabled", this service is not activated.
@@ -2304,7 +2304,7 @@ The file name is @i{target_name}.xml.
23042304
Hardware debuggers are parts of asynchronous systems,
23052305
where significant events can happen at any time.
23062306
The OpenOCD server needs to detect some of these events,
2307-
so it can report them to through TCL command line
2307+
so it can report them to through Tcl command line
23082308
or to GDB.
23092309

23102310
Examples of such events include:
@@ -2345,7 +2345,7 @@ specific information about the current state is printed.
23452345
An optional parameter
23462346
allows background polling to be enabled and disabled.
23472347

2348-
You could use this from the TCL command shell, or
2348+
You could use this from the Tcl command shell, or
23492349
from GDB using @command{monitor poll} command.
23502350
Leave background polling enabled while you're using GDB.
23512351
@example
@@ -4527,7 +4527,7 @@ mechanism for debugger targets.)
45274527
See the next section for information about the available events.
45284528

45294529
The @code{configure} subcommand assigns an event handler,
4530-
a TCL string which is evaluated when the event is triggered.
4530+
a Tcl string which is evaluated when the event is triggered.
45314531
The @code{cget} subcommand returns that handler.
45324532
@end deffn
45334533

@@ -4786,7 +4786,7 @@ The instance number is in bits 28..31 of DLPIDR value.
47864786

47874787
@deffn {Command} {dap names}
47884788
This command returns a list of all registered DAP objects. It it useful mainly
4789-
for TCL scripting.
4789+
for Tcl scripting.
47904790
@end deffn
47914791

47924792
@deffn {Command} {dap info} [@var{num}|@option{root}]
@@ -5775,7 +5775,7 @@ until the programming session is finished.
57755775
If you use @ref{programmingusinggdb,,Programming using GDB},
57765776
the target is prepared automatically in the event gdb-flash-erase-start
57775777

5778-
The jimtcl script @command{program} calls @command{reset init} explicitly.
5778+
The Tcl script @command{program} calls @command{reset init} explicitly.
57795779

57805780
@section Erasing, Reading, Writing to Flash
57815781
@cindex flash erasing
@@ -7462,18 +7462,18 @@ mspm0_board_reset
74627462

74637463
@end itemize
74647464

7465-
@deffn {TCL proc} {mspm0_board_reset}
7465+
@deffn {Tcl proc} {mspm0_board_reset}
74667466
Performs an nRST toggle on the device.
74677467
@end deffn
74687468

7469-
@deffn {TCL proc} {mspm0_mass_erase}
7469+
@deffn {Tcl proc} {mspm0_mass_erase}
74707470
Sends the mass erase command to the SEC-AP mailbox and then performs
74717471
an nRST toggle. Once the command has been fully processed by the ROM,
74727472
all MAIN memory will be erased. NOTE: This command is not supported
74737473
on MSPM0C* family of devices.
74747474
@end deffn
74757475

7476-
@deffn {TCL proc} {mspm0_factory_reset}
7476+
@deffn {Tcl proc} {mspm0_factory_reset}
74777477
Sends the factory reset command to the SEC-AP mailbox and then performs
74787478
an nRST toggle. Once the command has been fully processed by the ROM,
74797479
all MAIN memory will be erased and NONMAIN will be reset to its default
@@ -7772,7 +7772,7 @@ flash bank super_flash_toc2_cm4 psoc6 0x16007C00 0 0 0 \
77727772

77737773
psoc6-specific commands
77747774
@deffn {Command} {psoc6 reset_halt}
7775-
Command can be used to simulate broken Vector Catch from gdbinit or tcl scripts.
7775+
Command can be used to simulate broken Vector Catch from gdbinit or Tcl scripts.
77767776
When invoked for CM0+ target, it will set break point at application entry point
77777777
and issue SYSRESETREQ. This will reset both cores and all peripherals. CM0+ will
77787778
reset CM4 during boot anyway so this is safe. On CM4 target, VECTRESET is used
@@ -8987,7 +8987,7 @@ OpenOCD implements numerous ways to program the target flash, whether internal o
89878987
Programming can be achieved by either using @ref{programmingusinggdb,,Programming using GDB},
89888988
or using the commands given in @ref{flashprogrammingcommands,,Flash Programming Commands}.
89898989

8990-
@*To simplify using the flash commands directly a jimtcl script is available that handles the programming and verify stage.
8990+
@*To simplify using the flash commands directly a Tcl script is available that handles the programming and verify stage.
89918991
OpenOCD will program/verify/reset the target and optionally shutdown.
89928992

89938993
The script is executed as follows and by default the following actions will be performed.
@@ -9269,7 +9269,7 @@ non-zero exit code to the parent process.
92699269
If user types CTRL-C or kills OpenOCD, the command @command{shutdown}
92709270
will be automatically executed to cause OpenOCD to exit.
92719271

9272-
It is possible to specify, in the TCL list @var{pre_shutdown_commands} , a
9272+
It is possible to specify, in the Tcl list @var{pre_shutdown_commands} , a
92739273
set of commands to be automatically executed before @command{shutdown} , e.g.:
92749274
@example
92759275
lappend pre_shutdown_commands @{echo "Goodbye, my friend ..."@}
@@ -9858,7 +9858,7 @@ Add or replace usage text on the given @var{command_name}.
98589858
@deffn {Command} {ms}
98599859
Returns current time since the Epoch in ms
98609860
(See: @url{https://en.wikipedia.org/wiki/Epoch_(computing)}).
9861-
Useful to compute delays in TCL.
9861+
Useful to compute delays in Tcl.
98629862
@end deffn
98639863

98649864
@node Architecture and Core Commands
@@ -10175,7 +10175,7 @@ of the CTI.
1017510175

1017610176
@deffn {Command} {cti names}
1017710177
Prints a list of names of all CTI objects created. This command is mainly
10178-
useful in TCL scripting.
10178+
useful in Tcl scripting.
1017910179
@end deffn
1018010180

1018110181
@section Generic ARM
@@ -10819,7 +10819,7 @@ protocol used for trace data:
1081910819
@end itemize
1082010820

1082110821
@item @code{-event} @var{event_name} @var{event_body} -- assigns an event handler,
10822-
a TCL string which is evaluated when the event is triggered. The events
10822+
a Tcl string which is evaluated when the event is triggered. The events
1082310823
@code{pre-enable}, @code{post-enable}, @code{pre-disable} and @code{post-disable}
1082410824
are defined for TPIU/SWO.
1082510825
A typical use case for the event @code{pre-enable} is to enable the trace clock
@@ -11643,7 +11643,7 @@ capabilities than most of the other processors and in addition there is an
1164311643
extension interface that allows SoC designers to add custom registers and
1164411644
instructions. For the OpenOCD that mostly means that set of core and AUX
1164511645
registers in target will vary and is not fixed for a particular processor
11646-
model. To enable extensibility several TCL commands are provided that allow to
11646+
model. To enable extensibility several Tcl commands are provided that allow to
1164711647
describe those optional registers in OpenOCD configuration files. Moreover
1164811648
those commands allow for a dynamic target features discovery.
1164911649

@@ -11798,12 +11798,12 @@ configuration comprises two categories:
1179811798
@end enumerate
1179911799

1180011800
All common Xtensa support is built into the OpenOCD Xtensa target layer and
11801-
is enabled through a combination of TCL scripts: the target-specific
11801+
is enabled through a combination of Tcl scripts: the target-specific
1180211802
@file{target/xtensa.cfg} and a board-specific @file{board/xtensa-*.cfg},
1180311803
similar to other target architectures.
1180411804

1180511805
Importantly, core-specific configuration information must be provided by
11806-
the user, and takes the form of an @file{xtensa-core-XXX.cfg} TCL script that
11806+
the user, and takes the form of an @file{xtensa-core-XXX.cfg} Tcl script that
1180711807
defines the core's configurable features through a series of Xtensa
1180811808
configuration commands (detailed below).
1180911809

@@ -13376,7 +13376,7 @@ learning Tcl, the intent of this chapter is to give you some idea of
1337613376
how the Tcl scripts work.
1337713377

1337813378
This chapter is written with two audiences in mind. (1) OpenOCD users
13379-
who need to understand a bit more of how Jim-Tcl works so they can do
13379+
who need to understand a bit more of how Jim Tcl works so they can do
1338013380
something useful, and (2) those that want to add a new command to
1338113381
OpenOCD.
1338213382

@@ -13536,7 +13536,7 @@ Often many of those parameters are in @{curly-braces@} - thus the
1353613536
variables inside are not expanded or replaced until later.
1353713537

1353813538
Remember that every Tcl command looks like the classic ``main( argc,
13539-
argv )'' function in C. In JimTCL - they actually look like this:
13539+
argv )'' function in C. In Jim Tcl - they actually look like this:
1354013540

1354113541
@example
1354213542
int

0 commit comments

Comments
 (0)