Skip to content

Commit

Permalink
Merge pull request #1789 from masatake/misc-man-pages
Browse files Browse the repository at this point in the history
Misc man page fixes
  • Loading branch information
masatake committed Jul 10, 2018
2 parents 4469642 + d9ebd17 commit 5a4b6d0
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 20 deletions.
10 changes: 5 additions & 5 deletions main/options.c
Original file line number Diff line number Diff line change
Expand Up @@ -248,12 +248,12 @@ static optionDescription LongOptionDescription [] = {
{1," Include extra tag entries for selected information (flags: \"Ffq.\") [F]."},
{1," --extras-<LANG|*>=[+|-]flags"},
{1," Include <LANG> own extra tag entries for selected information"},
{1," (flags: --list-extras=<LANG>)."},
{1," (flags: see the output of --list-extras=<LANG> option)."},
{1," --fields=[+|-]flags"},
{1," Include selected extension fields (flags: \"afmikKlnsStzZ\") [fks]."},
{1," --fields-<LANG|*>=[+|-]flags"},
{1," Include selected <LANG> own extension fields"},
{1," (flags: --list-fields=<LANG>)."},
{1," (flags: see the output of --list-fields=<LANG> option)."},
{1," --file-scope=[yes|no]"},
{1," Should tags scoped only for a single file (e.g. \"static\" tags)"},
{1," be included in the output [yes]?"},
Expand Down Expand Up @@ -322,8 +322,6 @@ static optionDescription LongOptionDescription [] = {
{1," List the details of all tag kinds for specified language or all"},
{1," For each line, associated language name is printed when \"all\" is"},
{1," specified as language."},
{1," --list-langdef-flags"},
{1," Output list of flags which can be used with --langdef option."},
{1," --list-languages"},
{1," Output list of supported languages."},
{1," --list-map-extensions=[language|all]"},
Expand Down Expand Up @@ -459,6 +457,8 @@ static optionDescription ExperimentalLongOptionDescription [] = {
#endif
{1," --_list-kinddef-flags"},
{1," Output list of flags which can be used with --kinddef option."},
{1," --_list-langdef-flags"},
{1," Output list of flags which can be used with --langdef option."},
{1," --_list-mtable-regex-flags"},
{1," Output list of flags which can be used in a multitable regex parser definition."},
{1," --_mtable-extend-<LANG>=disttable+srctable."},
Expand Down Expand Up @@ -2666,7 +2666,6 @@ static parametricOption ParametricOptions [] = {
{ "list-fields", processListFieldsOption, true, STAGE_ANY },
{ "list-kinds", processListKindsOption, true, STAGE_ANY },
{ "list-kinds-full", processListKindsOption, true, STAGE_ANY },
{ "list-langdef-flags", processListLangdefFlagsOptions, true, STAGE_ANY },
{ "list-languages", processListLanguagesOption, true, STAGE_ANY },
{ "list-maps", processListMapsOption, true, STAGE_ANY },
{ "list-map-extensions", processListMapExtensionsOption, true, STAGE_ANY },
Expand Down Expand Up @@ -2697,6 +2696,7 @@ static parametricOption ParametricOptions [] = {
{ "_interactive", processInteractiveOption, true, STAGE_ANY },
#endif
{ "_list-kinddef-flags", processListKinddefFlagsOptions, true, STAGE_ANY },
{ "_list-langdef-flags", processListLangdefFlagsOptions, true, STAGE_ANY },
{ "_list-mtable-regex-flags", processListMultitableRegexFlagsOptions, true, STAGE_ANY },
#ifdef DO_TRACING
{ "_trace", processTraceOption, false, STAGE_ANY },
Expand Down
2 changes: 1 addition & 1 deletion man/ctags-incompatibilities.7.rst.in
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ extras including F/fileScope, then enabling only
q/qualified". Unexpectedly the command line becomes as if
"--file-scope=no" is set.

In this case the user should set "--extras=+q" instead of "--extras=q".
In this case, the user should set "--extras=+q" instead of "--extras=q".

Obsoleting ``--<LANG>-kinds`` option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
29 changes: 15 additions & 14 deletions man/ctags.1.rst.in
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,7 @@ are not listed here. They are experimental or debugging purpose.
Use backward searching patterns (e.g. ?pattern?). [Ignored in etags mode]

``-e``
Same as ``--output-format=etags``.
Enable etags mode, which will create a tag file for use with the Emacs
editor. Alternatively, if @CTAGS_NAME_EXECUTABLE@ is invoked by a
name containing the string "@ETAGS_NAME_EXECUTABLE@" (either by renaming,
Expand Down Expand Up @@ -837,7 +838,8 @@ are not listed here. They are experimental or debugging purpose.
Signature of routine (e.g. prototype or parameter list)

t/typeref
Type and name of a variable or typedef as "typeref:" field.
Type and name of a variable, typedef or return type of
callable like function as "typeref:" field.
Enabled by default.

z/kind
Expand Down Expand Up @@ -905,6 +907,11 @@ are not listed here. They are experimental or debugging purpose.
``--help``
Prints to standard output a detailed usage description, and then exits.

``--help-full``
Prints to standard output a detailed usage description about experimental
features, and then exits. Visit http://docs.ctags.io/en/latest about the
experimental features.

``--if0[=yes|no]``
Indicates a preference as to whether code within an "#if 0" branch of a
preprocessor conditional should be examined for non-macro tags (macro
Expand Down Expand Up @@ -1330,10 +1337,6 @@ are not listed here. They are experimental or debugging purpose.
Limits the depth of directory recursion enabled with the ``--recurse``
(``-R``) option.

``--optlib-dir=[+]directory``
Add an optlib *directory* to or reset **optlib** path list.
By default, the optlib path list is empty.

``--options=pathname``
Read additional options from file or directory.

Expand All @@ -1355,6 +1358,10 @@ are not listed here. They are experimental or debugging purpose.
Same as ``--options`` but doesn't cause an error if file
(or directory) specified with *pathname* doesn't exist.

``--optlib-dir=[+]directory``
Add an optlib *directory* to or reset **optlib** path list.
By default, the optlib path list is empty.

``--print-language``
Just prints the parsers for specified source files, and then exits.

Expand Down Expand Up @@ -1398,11 +1405,6 @@ are not listed here. They are experimental or debugging purpose.
during the current invocation of @CTAGS_NAME_EXECUTABLE@. This option
is off by default. This option must appear before the first file name.

``--undef[=yes|no]``
Specifies whether a macro tag should be generated from an #undef CPP
directive (in a C/C++ file), as if it were a #define directive. This
option is enabled by default.

``--verbose[=yes|no]``
Enable verbose mode. This prints out information on option processing
and a brief message describing what action is being taken for each file
Expand All @@ -1413,15 +1415,14 @@ are not listed here. They are experimental or debugging purpose.
the command line, it will take effect before any options are read from
these sources. The default is no.

``--with-list-header[=yes|no]``
Print headers describing columns in ``--list-`` option output.
See also "List options".

``--version``
Prints a version identifier for @CTAGS_NAME_EXECUTABLE@ to standard
output, and then exits. This is guaranteed to always contain the string
"Universal Ctags".

``--with-list-header[=yes|no]``
Print headers describing columns in ``--list-`` option output.
See also "List options".

OPERATIONAL DETAILS
-------------------
Expand Down

0 comments on commit 5a4b6d0

Please sign in to comment.