-
Notifications
You must be signed in to change notification settings - Fork 632
Documentation: getting started / tutorial #2464
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
Comments
How about providing ctags-example(1) man page? |
I'm working on improving readtags. After finishing, I will work on this topic. |
I wrote a short introduction for my class ago. |
A man page is not very visible. Better a markup that can be placed on github and maybe processed into html to be placed on the site. |
Do you know our man pages are visible as part the web site? |
sorry but your man pages are maybe good for advanced users |
Could you tell me more what you expect the ideal ... ctags-intro(1) document. I think normal users should not only ctags -R about ctags itself. BTW, I'm happy if you use '.' in your comments. Without periods, it is very hard for me to parse your comment. |
I think enough would be just copy and paste on your website what is here However I do not know if it is possible. If not, similar guides-tutorial |
...it seems that I'm not a good person to write such document. I myself use only https://vi.stackexchange.com/questions/22346/is-it-possible-to-create-a-snippet-to-expand-struct-members-to-fill In the comment, one writes about readtags. It is really nice comment. Anyway, I have to add ctags-faq(7) man page. |
I ended up learning a LOT about ctags over the decades. Believe me, I understand the frustration in figuring out how to effectively use ctags. I eventually created my own bash script wrapper around it that generates tags files for various libs in the system. This was the breakthrough for me... NOT having one massive tags file like everyone seems to want to do. |
@mr-mocap, impressive. I'm thinking about introduceing -r|--semantic-recursion and --path-=[+|-]... option. Consider foo.c
You will run ctags with following command line:
In the first pass, the C parser of ctags detects stdio.h is included. This idea is applicable to "import" of Python. I'm also thinking about psuedo tag named "!_TAG_INCLUDE_TAG". You may have an interest in #2427 |
I added ctags-faq(7) on #2855. It includes the contents of http://ctags.sourceforge.net/faq.html#15. Feel free to add more contents to the FAQ. |
Some users have been asking me for simple usage instructions for ctags and I couldn't find them. It would be nice to have a "getting started" guide that shows how to run ctags on a tree of sources, to turn on/off languages, kinds and fields and maybe how to hook everything up with an editor. It should be pretty short and condensed with eventual pointers to more information for deeper understanding.
One would expect to find it either on the first page of the site or on the github page.
An user pointed me to http://ctags.sourceforge.net/faq.html#15 as example. But I think it could be quite a lot nicer, maybe with some markup and a few ready-to-copy-and-paste examples.
The text was updated successfully, but these errors were encountered: