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

Create the release #664

Closed
7 tasks
cweagans opened this issue Nov 6, 2015 · 11 comments
Closed
7 tasks

Create the release #664

cweagans opened this issue Nov 6, 2015 · 11 comments

Comments

@cweagans
Copy link
Member

cweagans commented Nov 6, 2015

Depends on having the other issues in the milestone complete.

  • Create the tag
  • Create the release page on Github
  • Reply to the distro packaging issues to let them know about the release so that they can work on packaging
  • Ensure that all the platform distributions have built
  • Add links to the release for how to install + a link to how to build form source
  • Add changelog information (@cweagans can help with this - there's some overlap between this part and Write a release announcement for the website #659)
  • Add list of contributors for the initial release (For the first release, include everyone that contributed to exuberant ctags + everyone that contributed to universal ctags up till the point of the first release. For future releases, only include people that have contributed since the previous release).
@cweagans cweagans added this to the Initial release milestone Nov 6, 2015
@timfayz
Copy link

timfayz commented Nov 11, 2015

Hello, I don't know if I'm allowed to write here)..but please, give some more information to README regarding the following:

  • How to install for Linux. I know that I can do something like this ./configure && sudo make install, but it absolutely not obvious for newbies).
  • Direct link to list (or actual list of) supported languages. I learned about ctags only after I switched to Vim (btw, ctags is a great idea!). Because Vim uses ctags for jumping between definitions, it was a real pain to configure it to work with CSS+SCSS+HTML (example here http://stackoverflow.com/questions/33647614/how-to-configure-ctags-to-work-with-css-scss-html). By this I want to say it would be great if here was some popular use cases to work with ctags+Vim for the main web stack: JS, HTML/HTML with embedded CSS, CSS, Sass/LESS.
  • Information about that there is useful ~/.ctags file with some illustrations/examples how to work with. For example:
--exclude=*.min.js
--exclude=*.min.css
--exclude=*.map
--exclude=.sass-cache
--exclude=.git

--langdef=css
--langmap=css:.css
--regex-css=/^[ \t]*\.([A-Za-z0-9_-]+)/\1/c,class,classes/
....

--langdef=scss
--langmap=scss:.sass
--langmap=scss:+.scss
--regex-scss=/^[ \t]*@mixin ([A-Za-z0-9_-]+)/\1/m,mixin,mixins/
....
  • As I mentioned earlier, add a section Ctags + Vim with basic information about:
    • how to use your own name instead default tags file. For example, I like it to be hidden and use.ctags name instead;
    • vital config lines for ~/.vimrc: set tags+=name-of-tags-file;$HOME;
    • how to quickly update index using key mapping: nmap <leader><leader> :!ctags -R -f .tags<CR>;

Thank you)

@masatake
Copy link
Member

@timfayz, thank you for comments. There are too many issues, so I can solve all your issues at once.

How to install for Linux,...

Could you look at https://github.com/universal-ctags/ctags/blob/master/docs/autotools.rst ?
However, poeple work on making a binary package. So you can wait for the result of efforts.

I am the bottle neck.

Direct link to list (or actual list of) supported languages.
Run ctags --list-languages.

I'm sorry but I don't have time to work on languages web stack area. Instead I will work on improving the facilities for developing parsers for languages web stack area.

Instead of putting our great regex based parser to your ~/.ctags, I would like you to consider submit it to here as a pull request.

masatake@dc1427d

https://github.com/universal-ctags/ctags/blob/master/docs/optlib.rst
#92
#614
https://github.com/universal-ctags/ctags/tree/master/data/optlib

ctags has built-in css parser imported from geany. I don't know about css. It seems that "classes' are captured:

% ./ctags --list-kinds=Css
./ctags --list-kinds=Css
c  classes
s  selectors
i  identities

About html I'm thinking about using XML meta parser.
#519

Embedded language cannot be handled well yet.
#64

I think we have to implement something stackable input streams".

Information about that there is useful
I'm waiting for your pull requests:-)

As I mentioned earlier, add a section Ctags + Vim with basic information about:
I am a bad person for replying this comment because I am using vim only for administration task.
GNU Emacs is my editor. Other developers may give you better answers.

@cweagans, should we not use here for this discussion?

@timfayz
Copy link

timfayz commented Nov 12, 2015

https://github.com/universal-ctags/ctags/blob/master/docs/autotools.rst

I've already seen it) Yeah, the instructions are intended for Linux users, but I think it will be much simpler if it was explicitly defined as Linux installation. It won't confuse newbies with unknow commands and concepts like $ autoreconf -vfi, "Autotools-based projects" etc. Just do this, that and be happy)

ctags --list-languages

Good point, but what if I want to list them prior to installation? I think you will agree that the repo should be intended not only for experts and advanced ("Do you know ctags? Yes I do. Joint to the party, my friend! If you don't get out of here!"), but to absolutely new that hears about ctags for the first time.

I'm sorry but I don't have time to work on languages web stack area. Instead I will work on improving the facilities for developing parsers for languages web stack area.

Ok, I'll hope for the better future)

If I understand your correctly - regarding the pull request and participating - C isn't my primary language, so I'm sorry) Thank you for the links and detailed explanation. I've read visit them, but I don't have much time to dig into internals. I think, I go back here later if I faced with usage problems.

masatake added a commit to masatake/ctags that referenced this issue Nov 12, 2015
@masatake
Copy link
Member

I've already seen it)...

Could you review #671 ?
If you are not familiar with GNU, don't ask me about it.
see http://www.gnu.org/gnu/linux-and-gnu.en.html .

ctags --list-languages

Good point, but what if I want to list them prior to installation? I think you will agree that the repo should be intended not only for experts and advanced ("Do you know ctags? Yes I do. Joint to the party, my friend! If you don't get out of here!"), but to absolutely new that hears about ctags for the first time.

I wonder how can we do it well... does anyone have good idea? Githook can help us?

If I understand your correctly - regarding the pull request and participating - C isn't my primary language, so I'm sorry) Thank you for the links and detailed explanation. I've read visit them, but I don't have much time to dig into internals. I think, I go back here later if I faced with usage problems.

About writing regex based parser, you don't need knowledge about C.
The most important thing in writing a parser is the knowledge of the target language.
Defining kinds for the language is really difficult. I took many mistakes in this area.

If a regex parser is not enough you can write a parser with any language you want.
ctags can run an external tag generator for specified language as xcmd.

If you are seriouly interested in handling a particular language, open an issue like scala(#654).

For extending ctags internal exclusion list, the knowledge about C language is needed.
See initOptions of https://github.com/universal-ctags/ctags/blob/master/main/options.c

About handling nested languages, give me good and attractive example. You can add an example to #64
These good example drives the development.

@cweagans
Copy link
Member Author

I wonder how can we do it well... does anyone have good idea? Githook can help us?

Docs will solve this, and we can improve the website too.

I think there are 3-4 separate issues that can be opened from the above discussion. This issue is more for tracking the specific things that we need to do to get the release out the door.

@vhda
Copy link
Contributor

vhda commented Nov 12, 2015

Regarding vim+ctags documentation, I don't think this is the right place for that. If we do it, then we would have to create such a document for each editor that supports tags files. And there are too many of them!

I'm sure that a quick Google search will show return many sites explaining tags file usage in the various editors available.

Nevertheless, vim includes extended documentation:

:help tagsrch.txt
:help 'tags'

These two help entries should get you started :)

@masatake
Copy link
Member

I revised issues that are in 1.0.0 milestone.
I added what I want in 1.0.0, too.
Introducing automake may be the biggest one.

@masatake
Copy link
Member

@timfayz, there are some examples of regex parsers at https://github.com/universal-ctags/ctags-xparsers .

@andreasstieger
Copy link

So are you making a release anytime soon? This is what distribution maintainers would be looking for, usually.

@masatake
Copy link
Member

I'm very sorry but I don't have a plan to release.

@masatake masatake modified the milestones: 1.0.0: focusing on binary distributions, Mn for 6.0 Jun 26, 2017
@masatake
Copy link
Member

I'm thinking about releasing 6.0.
Though @cweagans listed the tasks for releasing, I will just put a tag.
So I can take my time improving parsers like Fortran and Cobol:-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants