Skip to content

Commit 0a5b489

Browse files
authored
Update README.md for ctags (#433)
Signed-off-by: Hiroo HAYASHI <[email protected]>
1 parent 73955a0 commit 0a5b489

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,22 @@ Install it from [VS Code Marketplace](https://marketplace.visualstudio.com/items
5555

5656
This extension uses the tags created using Ctags to provide many of its features. It is recommended to use [Universal Ctags](https://github.com/universal-ctags/ctags) as it supports SystemVerilog also, compared to Exuberant Ctags and other older versions. The tags are stored in memory and not as separate files.
5757

58+
Currently the integrated feature supports only tags in the currently opened file, not tags in other files.
59+
However, you can use other independent Ctags extensions to find definitions from any file.
60+
61+
For example [Ctags Companion](https://github.com/gediminasz/ctags-companion) works well with this extension
62+
by adding the following settings on `.vscode/settings.json` in your workspace.
63+
64+
```json
65+
{
66+
"ctags-companion.command": "ctags -R --fields=+nKz -f .vscode/.tags --langmap=SystemVerilog:+.v -R rtl /opt/uvm-1.2/src",
67+
"ctags-companion.readtagsEnabled": true,
68+
}
69+
```
70+
71+
It searches for definitions not only in the workspace, but also in files outside the workspace (ex. `/opt/uvm-1.2/src` in the example above).
72+
It also supports the `readtags` command included in Universal Ctags, allowing for fast searches from large workspaces.
73+
5874
#### Installation of Universal Ctags
5975

6076
- Windows - Daily builds are available at [ctags-win32](https://github.com/universal-ctags/ctags-win32)

0 commit comments

Comments
 (0)