2
2
Reference codebase for Universal-ctags
3
3
==============================================================
4
4
5
- This is the reference codebase for measuring the performance of
5
+ This is the reference code base for measuring the performance of
6
6
Universal-ctags parsers.
7
7
8
8
@@ -38,7 +38,7 @@ We assume you may have enough storage space on your PC.
38
38
39
39
.. code-block :: console
40
40
41
- $ ./codebae clone C
41
+ $ ./codebase clone C
42
42
...
43
43
44
44
2. Run Universal-ctags for the cloned code with following command line:
@@ -47,7 +47,8 @@ We assume you may have enough storage space on your PC.
47
47
48
48
$ [CTAGS_EXE=${where your ctags executable is}] ./codebase ctags <LANGUAGE> [<PROFILE>]
49
49
50
- codebase refers *CTAGS_EXE * environment variable to run ctags.
50
+ `codebase ` refers *CTAGS_EXE * environment variable to run ctags. If
51
+ CTAGS_EXE is not defined, `ctags ` is used as the command name.
51
52
52
53
You can run ctags with different option combination.
53
54
We call such option combination *PROFILE *.
@@ -92,26 +93,38 @@ We assume you may have enough storage space on your PC.
92
93
How to add your code to code base
93
94
==============================================================
94
95
96
+ The code to be added to the code base must have a git repository.
97
+
95
98
You have to write a .lcopy file and put it to lcopy.d directory.
96
99
See lcopy.d/linux.lcopy as an example::
97
100
98
101
REPO=https://github.com/torvalds/linux
99
102
ALIGNMENT=v4.20
100
103
LANGUAGES=C,LdScript,Asm,Kconfig,DTS
101
104
105
+ `codebase ` commands loads a .lcopy file with source built-in command. In
106
+ a .lcopy file must define `REPO `, `ALIGNMENT `, and `LANGUAGES `.
107
+
102
108
`REPO ` specifies a git repository. `ALIGNMENT ` is a tag put on the
103
- git repository. `ALIGNMENT ` allows users of codebase to get the same
104
- source tree. `LANGUAGES ` is a comma separated language list.
109
+ git repository. `ALIGNMENT ` allows users of `codebase ` to get the same
110
+ source tree. Specify a git tag or commit as `ALIGNMENT `. A git branch
111
+ is not acceptable. `LANGUAGES ` is a comma separated language list.
105
112
106
113
107
- How to add your profile to preset list
114
+ How to add a new profile
108
115
==============================================================
109
116
110
- You have to write a .ctags file and put it to profile.d directory.
111
- A line started from "# @" is used as a description for the profile.
112
- You may wan to use `--options-maybe ` to extend profile without
113
- modifying existing .ctags files.
117
+ Add a .ctags file under profile.d directory.
118
+ In the .ctags file, a line started from "# @" is used as a
119
+ description for the profile.
120
+
121
+ You may want to use `--options ` to extend profile without
122
+ modifying existing .ctags files. If you want to extend `base.ctags `
123
+ in the profile.d directory, write your profile (`extended.ctags `)
124
+ as following::
114
125
126
+ --options=base.ctags
127
+ ...
115
128
116
129
Let's optimize our parsers!
117
130
Masatake YAMATO <
[email protected] >
0 commit comments