zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

David Brownell <david-b@pacbell.net> Minor doc updates: 

- Itemize the list of private customization examples
  for openocd.cfg

 - Add "override defaults" as a customization, specifically
  for the work area (back it up or relocate it)

 - Highlight some work area location issues

git-svn-id: svn://svn.berlios.de/openocd/trunk@2651 b42882b7-edfa-0310-969c-e2dbd0fdcd60
__archive__
oharboe 2009-08-30 17:32:56 +00:00
parent d879faa3cb
commit ab30d5203c
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/openocd.texi
View File

@ -733,11 +733,15 @@ You may find a board configuration that's a good example to follow.
When you write config files, separate the reusable parts When you write config files, separate the reusable parts
(things every user of that interface, chip, or board needs) (things every user of that interface, chip, or board needs)
from ones specific to your environment and debugging approach. from ones specific to your environment and debugging approach.
@itemize
@item
For example, a @code{gdb-attach} event handler that invokes For example, a @code{gdb-attach} event handler that invokes
the @command{reset init} command will interfere with debugging the @command{reset init} command will interfere with debugging
early boot code, which performs some of the same actions early boot code, which performs some of the same actions
that the @code{reset-init} event handler does. that the @code{reset-init} event handler does.
@item
Likewise, the @command{arm9tdmi vector_catch} command (or Likewise, the @command{arm9tdmi vector_catch} command (or
@cindex vector_catch @cindex vector_catch
its siblings @command{xscale vector_catch} its siblings @command{xscale vector_catch}
@ -747,9 +751,16 @@ Keep those kinds of debugging aids in your user config file,
along with messaging and tracing setup. along with messaging and tracing setup.
(@xref{Software Debug Messages and Tracing}.) (@xref{Software Debug Messages and Tracing}.)
@item
You might need to override some defaults.
For example, you might need to move, shrink, or back up the target's
work area if your application needs much SRAM.
@item
TCP/IP port configuration is another example of something which TCP/IP port configuration is another example of something which
is environment-specific, and should only appear in is environment-specific, and should only appear in
a user config file. @xref{TCP/IP Ports}. a user config file. @xref{TCP/IP Ports}.
@end itemize
@section Project-Specific Utilities @section Project-Specific Utilities
@ -2614,9 +2625,12 @@ same event name assigns only one handler.
which OpenOCD needs to know about. which OpenOCD needs to know about.
@item @code{-work-area-backup} (@option{0}|@option{1}) -- says @item @code{-work-area-backup} (@option{0}|@option{1}) -- says
whether the work area gets backed up; by default, it doesn't. whether the work area gets backed up; by default,
@emph{it is not backed up.}
When possible, use a working_area that doesn't need to be backed up, When possible, use a working_area that doesn't need to be backed up,
since performing a backup slows down operations. since performing a backup slows down operations.
For example, the beginning of an SRAM block is likely to
be used by most build systems, but the end is often unused.
@item @code{-work-area-size} @var{size} -- specify/set the work area @item @code{-work-area-size} @var{size} -- specify/set the work area