doc/openocd.texi: Document find and ocd_find command
authorYasushi SHOJI <yashi@spacecubics.com>
Sun, 21 Nov 2021 23:48:26 +0000 (08:48 +0900)
committerAntonio Borneo <borneo.antonio@gmail.com>
Sat, 11 Dec 2021 17:42:52 +0000 (17:42 +0000)
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>
doc/openocd.texi

index fa1b8da05a44bd48008bd7aca3851aec75013dbc..1a336a75a1299c7c3d9bc898ae21d131cc5e3865 100644 (file)
@@ -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