Skip to content

Commit e13bb0d

Browse files
committed
docs(man): write about -C/--canonicalize-input option of readtags
Signed-off-by: Masatake YAMATO <[email protected]>
1 parent 2af4827 commit e13bb0d

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/man/readtags.1.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ Controlling the Output
7373
By default, the output of readtags contains only the name, input and pattern
7474
field. The Output can be tweaked using these options:
7575

76+
``-C``, ``--canonicalize-input``
77+
Reduct '..' and '.' in input fields of regular tags.
78+
This option works only with tags files having ``!_TAG_PROC_CWD`` pseudo
79+
tag.
80+
81+
NOTE: The current implementation accepts only ``!_TAG_PROC_CWD``
82+
starting with ``/``; a Windows directory name starting with a
83+
drive letter like ``C:\Somewhere`` is not acceptable.
84+
7685
``-d``, ``--debug``
7786
Turn on debugging output.
7887

man/readtags.1.rst.in

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ Controlling the Output
7373
By default, the output of readtags contains only the name, input and pattern
7474
field. The Output can be tweaked using these options:
7575

76+
``-C``, ``--canonicalize-input``
77+
Reduct '..' and '.' in input fields of regular tags.
78+
This option works only with tags files having ``!_TAG_PROC_CWD`` pseudo
79+
tag.
80+
81+
NOTE: The current implementation accepts only ``!_TAG_PROC_CWD``
82+
starting with ``/``; a Windows directory name starting with a
83+
drive letter like ``C:\Somewhere`` is not acceptable.
84+
7685
``-d``, ``--debug``
7786
Turn on debugging output.
7887

0 commit comments

Comments
 (0)