This is an automated email from Gerrit.
"Yasushi SHOJI <yasushi.sh...@gmail.com>" just uploaded a new patch set to
Gerrit, which you can find at https://review.openocd.org/c/openocd/+/6737
-- gerrit
commit 514bd9d26babcbed5f907b768770a9b289ff87c4
Author: Yasushi SHOJI <ya...@spacecubics.com>
Date: Mon Nov 22 08:48:26 2021 +0900
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 <ya...@spacecubics.com>
diff --git a/doc/openocd.texi b/doc/openocd.texi
index 6fddd9e3b..3c83c8aac 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
@@ -2049,7 +2059,7 @@ multiple tokens. (command valid any time)
In this document, the modes are described as stages, 'config' and
'exec' mode correspond configuration stage and run stage. 'any' means
the command can be executed in either
-stages. @xref{configurationstage,,Configuration Stage} and
+stages. @xref{configurationstage,,Configuration Stage}, and
@xref{enteringtherunstage,,Entering the Run Stage}.
@end deffn
--
