diff options
| author | Yasushi SHOJI <yashi@spacecubics.com> | 2021-11-22 08:48:26 +0900 |
|---|---|---|
| committer | Antonio Borneo <borneo.antonio@gmail.com> | 2021-12-11 17:42:52 +0000 |
| commit | e5a93e3e7adbc0a394df9953695f7bc27eab18ce (patch) | |
| tree | 726fae90edc8523a68354b89149f7315e85ae0b4 /doc | |
| parent | 37407f4a7b711896ff5fdc1dd98740ebd013cb2c (diff) | |
| download | riscv-openocd-e5a93e3e7adbc0a394df9953695f7bc27eab18ce.zip riscv-openocd-e5a93e3e7adbc0a394df9953695f7bc27eab18ce.tar.gz riscv-openocd-e5a93e3e7adbc0a394df9953695f7bc27eab18ce.tar.bz2 | |
doc/openocd.texi: Document find and ocd_find command
Document both find and ocd_find command under Config File Guidelines
-> Interface Config Files. find command is used in the previous
section as well but the previous section is more about using OpenOCD.
The section added is "aimed at any user who needs to write a config
file".
Change-Id: I698207fe58d564c615a15b50756aa5547a5f40b7
Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/6737
Tested-by: jenkins
Reviewed-by: Antonio Borneo <borneo.antonio@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/openocd.texi | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index fa1b8da..1a336a7 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -1359,6 +1359,16 @@ Read the OpenOCD source code (and Developer's Guide) if you have a new kind of hardware interface and need to provide a driver for it. +@deffn {Command} {find} 'filename' +Prints full path to @var{filename} according to OpenOCD search rules. +@end deffn + +@deffn {Command} {ocd_find} 'filename' +Prints full path to @var{filename} according to OpenOCD search rules. This +is a low level function used by the @command{find}. Usually you want +to use @command{find}, instead. +@end deffn + @section Board Config Files @cindex config file, board @cindex board config file |