docs(man): write about -C/--canonicalize-input option of readtags

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
universal-ctags · Oct 15, 2022 · 185f8b8 · 185f8b8
1 parent 2db599b
commit 185f8b8
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/man/readtags.1.rst b/docs/man/readtags.1.rst
@@ -72,6 +72,15 @@ Controlling the Output
 By default, the output of readtags contains only the name, input and pattern
 field. The Output can be tweaked using these options:
 
+``-C``, ``--canonicalize-input``
+	Reduct '..' and '.' in input fields of regular tags.
+	This option works only with tags files having ``!_TAG_PROC_CWD`` pseudo
+	tag.
+
+	NOTE: The current implementation accepts only ``!_TAG_PROC_CWD``
+	starting with ``/``; a Windows directory name starting with a
+	drive letter like ``C:\Somewhere`` is not acceptable.
+
 ``-d``, ``--debug``
 	Turn on debugging output.
 

diff --git a/man/readtags.1.rst.in b/man/readtags.1.rst.in
@@ -72,6 +72,15 @@ Controlling the Output
 By default, the output of readtags contains only the name, input and pattern
 field. The Output can be tweaked using these options:
 
+``-C``, ``--canonicalize-input``
+	Reduct '..' and '.' in input fields of regular tags.
+	This option works only with tags files having ``!_TAG_PROC_CWD`` pseudo
+	tag.
+
+	NOTE: The current implementation accepts only ``!_TAG_PROC_CWD``
+	starting with ``/``; a Windows directory name starting with a
+	drive letter like ``C:\Somewhere`` is not acceptable.
+
 ``-d``, ``--debug``
 	Turn on debugging output.