Skip to content

Commit a252f1b

Browse files
committed
Revise README based on the comments from @hirooih at #5
Signed-off-by: Masatake YAMATO <[email protected]>
1 parent e94c9d8 commit a252f1b

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.rst

+23-10
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Reference codebase for Universal-ctags
33
==============================================================
44

5-
This is the reference codebase for measuring the performance of
5+
This is the reference code base for measuring the performance of
66
Universal-ctags parsers.
77

88

@@ -38,7 +38,7 @@ We assume you may have enough storage space on your PC.
3838

3939
.. code-block:: console
4040
41-
$ ./codebae clone C
41+
$ ./codebase clone C
4242
...
4343

4444
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.
4747
4848
$ [CTAGS_EXE=${where your ctags executable is}] ./codebase ctags <LANGUAGE> [<PROFILE>]
4949

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.
5152

5253
You can run ctags with different option combination.
5354
We call such option combination *PROFILE*.
@@ -92,26 +93,38 @@ We assume you may have enough storage space on your PC.
9293
How to add your code to code base
9394
==============================================================
9495

96+
The code to be added to the code base must have a git repository.
97+
9598
You have to write a .lcopy file and put it to lcopy.d directory.
9699
See lcopy.d/linux.lcopy as an example::
97100

98101
REPO=https://github.com/torvalds/linux
99102
ALIGNMENT=v4.20
100103
LANGUAGES=C,LdScript,Asm,Kconfig,DTS
101104

105+
`codebase` commands loads a .lcopy file with source built-in command. In
106+
a .lcopy file must define `REPO`, `ALIGNMENT`, and `LANGUAGES`.
107+
102108
`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.
105112

106113

107-
How to add your profile to preset list
114+
How to add a new profile
108115
==============================================================
109116

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::
114125

126+
--options=base.ctags
127+
...
115128

116129
Let's optimize our parsers!
117130
Masatake YAMATO <[email protected]>

0 commit comments

Comments
 (0)