Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

format-3: update (merge the master branch) #1736

Merged
merged 12 commits into from
Apr 15, 2018

Conversation

masatake
Copy link
Member

No description provided.

masatake and others added 12 commits December 30, 2017 01:03
…put-format=u-ctags|e-ctags option

To record meta characters like tab in a name, we have designed new file format.

The file format itself was already introduced. TAG_OUTPUT_MODE pseudo tag was used
as marker telling which format is used in a tag file: Exuberant-ctags(e-ctags)
compatible format or Universal-ctags(u-ctags) file format. u-ctags was the default
format. A user could choose the format with --output-format option.

However, we recognize that the hack using TAG_OUTPUT_MODE pseudo doesn't work well
with readtags command. A data structure of readtags doesn't have a field for
recording TAG_OUTPUT_MODE. It means readtags cannot switch the file format version
dynamically. The pseudo tags can be used in readtags for the purpose, recognizing
the file format is only TAG_FILE_FORMAT.

This commit introduces following SELF INCOMPATIBLE changes:

1. --output-format=u-ctags and --output-format=e-ctags are removed.
   They are unified to --output-format=ctags.

2. TAG_OUTPUT_MODE pseudo tag is removed.
   Instead TAG_FILE_FORMAT=3 is introduced.
   TAG_FILE_FORMAT=2 is compatible with e-ctags.
   TAG_FILE_FORMAT=3 is default. A user can choose one of the formats
   with --format=3 or --format=2.

The new "version 3" may break many client tools.
If you are just user of such client tools, use --format=2 option to generate
tags file with compatible file format.
If you are a developer of such client tools, please, consider to support
--format=3.

The rest of work are:

1. more Tmain test cases,
2. more precise documentation about the format 3.
3. updating readtags to support format 3.

About readtags, the most of all work is done by @b4n.
I must merge his changes(universal-ctags#1605).

docs/news.rst are rewritten by @b4n and @codebrainz.

Ussing stringfy for printing default version of file format in --help
message is suggested by @b4n.

Signed-off-by: Masatake YAMATO <yamato@redhat.com>
[SELF INCOMPATIBLE] main: introduce version 3 format and remove --out…
Merge the latest changes on master branch
Merge the latest changes in master branch
Merge the latest changes in master to format-3 branch
@coveralls
Copy link

Coverage Status

Coverage increased (+0.01%) to 84.798% when pulling 6081a30 on masatake:format-3 into 207f4c3 on universal-ctags:master.

@masatake masatake merged commit 701c53d into universal-ctags:master Apr 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants