From e5a93e3e7adbc0a394df9953695f7bc27eab18ce Mon Sep 17 00:00:00 2001 From: Yasushi SHOJI Date: Mon, 22 Nov 2021 08:48:26 +0900 Subject: [PATCH] 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 Reviewed-on: https://review.openocd.org/c/openocd/+/6737 Tested-by: jenkins Reviewed-by: Antonio Borneo --- doc/openocd.texi | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/openocd.texi b/doc/openocd.texi index fa1b8da05..1a336a75a 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