changeset 35870:d65d3d29e9ac

runtime(doc): re-format tag example lines, mention ctags --list-kinds Commit: https://github.com/vim/vim/commit/5b07213c0b365f2a7fcdd10c7e7cd00aae3560a5 Author: Christian Brabandt <cb@256bit.org> Date: Thu Aug 1 09:25:58 2024 +0200 runtime(doc): re-format tag example lines, mention ctags --list-kinds Signed-off-by: Christian Brabandt <cb@256bit.org>
author Christian Brabandt <cb@256bit.org>
date Thu, 01 Aug 2024 09:30:07 +0200
parents 407b352f3b19
children 1758bb7a9865
files runtime/doc/tagsrch.txt
diffstat 1 files changed, 11 insertions(+), 9 deletions(-) [+]
line wrap: on
line diff
--- a/runtime/doc/tagsrch.txt
+++ b/runtime/doc/tagsrch.txt
@@ -1,4 +1,4 @@
-*tagsrch.txt*   For Vim version 9.1.  Last change: 2024 Mar 16
+*tagsrch.txt*   For Vim version 9.1.  Last change: 2024 Aug 01
 
 
 		  VIM REFERENCE MANUAL    by Bram Moolenaar
@@ -588,12 +588,12 @@ ctags).
 {term}		;" The two characters semicolon and double quote.  This is
 		interpreted by Vi as the start of a comment, which makes the
 		following be ignored.  This is for backwards compatibility
-		with Vi, it ignores the following fields. Example:
+		with Vi, it ignores the following fields. Example: >
 			APP	file	/^static int APP;$/;"	v
-		When {tagaddress} is not a line number or search pattern, then
+<		When {tagaddress} is not a line number or search pattern, then
 		{term} must be |;".  Here the bar ends the command (excluding
 		the bar) and ;" is used to have Vi ignore the rest of the
-		line.  Example:
+		line.  Example: >
 			APP	file.c	call cursor(3, 4)|;"	v
 
 {field} ..	A list of optional fields.  Each field has the form:
@@ -611,7 +611,9 @@ ctags).
 
 		There is one field that doesn't have a ':'.  This is the kind
 		of the tag.  It is handled like it was preceded with "kind:".
-		See the documentation of ctags for the kinds it produces.
+		In the above example, this was "kind:v" (typically variable).
+		See the documentation of ctags for the kinds it produces, with
+		ctags you can use `ctags --list-kinds` .
 
 		The only other field currently recognized by Vim is "file:"
 		(with an empty value).  It is used for a static tag.
@@ -656,14 +658,14 @@ If the command is a normal search comman
   The direction of the search is forward for "/", backward for "?".
   Note that 'wrapscan' does not matter, the whole file is always searched.
 - If the search fails, another try is done ignoring case.  If that fails too,
-  a search is done for:
+  a search is done for: >
 	"^tagname[ \t]*("
-  (the tag with '^' prepended and "[ \t]*(" appended).  When using function
+<  (the tag with '^' prepended and "[ \t]*(" appended).  When using function
   names, this will find the function name when it is in column 0.  This will
   help when the arguments to the function have changed since the tags file was
-  made.  If this search also fails another search is done with:
+  made.  If this search also fails another search is done with: >
 	"^[#a-zA-Z_].*\<tagname[ \t]*("
-  This means: A line starting with '#' or an identifier and containing the tag
+<  This means: A line starting with '#' or an identifier and containing the tag
   followed by white space and a '('.  This will find macro names and function
   names with a type prepended.