Skip to content

Commit 3ec38c9

Browse files
committed
docs(man): write about the incompatibility about --excmd=mixed option
Close #3557. Signed-off-by: Masatake YAMATO <[email protected]>
1 parent 2cb65d3 commit 3ec38c9

File tree

4 files changed

+22
-4
lines changed

4 files changed

+22
-4
lines changed

docs/man/ctags-incompatibilities.7.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ Environment variables for arranging command lines
3434
Universal Ctags doesn't read ``CTAGS`` and/or ``ETAGS`` environment
3535
variables.
3636

37+
Behavior when ``--excmd=mixed`` is given
38+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39+
Exuberant Ctags uses line numbers as addresses for C preprocessor
40+
macro definition tags. Universal Ctags uses patterns for the tags.
41+
3742
Incompatibilities in command line interface
3843
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3944

docs/man/ctags.1.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,12 +563,16 @@ See "`TAG ENTRIES`_" about fields, kinds, roles, and extras.
563563
removed since the tag file was generated.
564564

565565
``mixed``
566-
In this mode, patterns are generally used with a few exceptions.
567-
For C, line numbers are used for macro definition tags. For Fortran, line numbers
566+
In this mode, patterns are generally used with an exceptions.
567+
For Fortran, line numbers
568568
are used for common blocks because their corresponding source lines
569569
are generally identical, making pattern searches useless
570570
for finding all matches.
571571

572+
Exuberant Ctags has one more exception; for C, line numbers are used
573+
for macro definition tags. Universal Ctags doesn't have this exception
574+
for C.
575+
572576
This was the default format generated by the original ctags and is,
573577
therefore, retained as the default for this option.
574578

man/ctags-incompatibilities.7.rst.in

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,11 @@ Environment variables for arranging command lines
3434
Universal Ctags doesn't read ``CTAGS`` and/or ``ETAGS`` environment
3535
variables.
3636

37+
Behavior when ``--excmd=mixed`` is given
38+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
39+
Exuberant Ctags uses line numbers as addresses for C preprocessor
40+
macro definition tags. Universal Ctags uses patterns for the tags.
41+
3742
Incompatibilities in command line interface
3843
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3944

man/ctags.1.rst.in

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,12 +563,16 @@ See "`TAG ENTRIES`_" about fields, kinds, roles, and extras.
563563
removed since the tag file was generated.
564564

565565
``mixed``
566-
In this mode, patterns are generally used with a few exceptions.
567-
For C, line numbers are used for macro definition tags. For Fortran, line numbers
566+
In this mode, patterns are generally used with an exceptions.
567+
For Fortran, line numbers
568568
are used for common blocks because their corresponding source lines
569569
are generally identical, making pattern searches useless
570570
for finding all matches.
571571

572+
Exuberant Ctags has one more exception; for C, line numbers are used
573+
for macro definition tags. Universal Ctags doesn't have this exception
574+
for C.
575+
572576
This was the default format generated by the original ctags and is,
573577
therefore, retained as the default for this option.
574578

0 commit comments

Comments
 (0)