xref: /Universal-ctags/.github/ISSUE_TEMPLATE.md (revision 070f4b34b1b7ebc1c7e1b69deae4985295476366)
1(
2Thank you for contacting us.
3
4If you are reporting an issue with the parsing output, please fill
5the following template.  As your custom CTags configuration can
6affect results, please always use `--options=NONE` as the first
7option when running `ctags`.
8
9Otherwise, delete the template and write your issue from scratch.
10Examples may help developers understanding your issue better.
11
12Use GitHub web interface and markdown notation.
13Using mail results broken text rendering that makes
14the developers go crazy.
15)
16
17*****
18
19The name of the parser:
20
21
22The command line you used to run ctags:
23
24```
25$ ctags --options=NONE ...
26```
27
28The content of input file:
29
30```C
31/* THIS IS AN EXAMPLE */
32int
33main(void)
34{
35	...
36```
37
38The tags output you are not satisfied with:
39
40```
41!_THIS_IS_AN_EXAMPLE
42mainVoid	foo.c	/^main(void)$/;"	kind:function	line:2	language:C	typeref:typename:int	signature:(void)	roles:def
43...
44```
45
46The tags output you expect:
47
48```
49!_THIS_IS_AN_EXAMPLE
50main	foo.c	/^main(void)$/;"	kind:function	line:2	language:C	typeref:typename:int	signature:(void)	roles:def
51...
52```
53
54The version of ctags:
55
56```
57$ ctags --version
58Universal Ctags 0.0.0(EXAMPLE), Copyright (C) 2015 Universal Ctags Team
59Universal Ctags is derived from Exuberant Ctags.
60Exuberant Ctags 5.8, Copyright (C) 1996-2009 Darren Hiebert
61  Compiled: May 11 1018, 23:16:36
62  URL: https://ctags.io/
63  Optional compiled features: +wildcards, +regex, +iconv, +option-directory, +xpath, +json, +interactive, +sandbox, +yaml
64```
65
66How do you get ctags binary:
67
68(
69Building it locally, via GNU/Linux distribution, as BSD's package,
70win32 binary taken from Universal-ctags/ctags-win32 project, macosx
71binary taken from Universal-ctags/homebrew-universal-ctags project,
72etc.
73)
74