-
Notifications
You must be signed in to change notification settings - Fork 630
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
Verilog: extract module names used for defining instances as reference tags #3473
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3473 +/- ##
==========================================
+ Coverage 83.33% 83.34% +0.01%
==========================================
Files 219 219
Lines 52760 52796 +36
==========================================
+ Hits 43966 44002 +36
Misses 8794 8794
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we discussed on #3469, defInstance
is not proper name for the role of the tag.
I think "decl" or "declaration" is better.
Other than this, your fix is clean and readable as usual.
Thank you.
I see. I will update the name of the role. I will keep this draft till I write about |
a47d310
to
b2a0ea9
Compare
I see. |
b2a0ea9
to
3e09622
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you.
Please merge this when you think you are ready.
3e09622
to
56f3ade
Compare
The man page is updated. |
docs/man/ctags-lang-verilog.7.rst
Outdated
Supported Roles | ||
~~~~~~~~~~~~~~~ | ||
|
||
.. warning:: | ||
|
||
The support for references in Universal Ctags is still | ||
experimental; the names of the roles can be changed in the future. | ||
|
||
|
||
.. code-block:: console | ||
|
||
$ ./ctags --list-roles=SystemVerilog | ||
#KIND(L/N) NAME ENABLED DESCRIPTION | ||
m/module decl on declaring instances | ||
|
||
$ ./ctags --list-roles=Verilog | ||
#KIND(L/N) NAME ENABLED DESCRIPTION | ||
m/module decl on declaring instances | ||
|
||
The parsers extract modules names used in instance declarations as | ||
reference tags. ``decl`` is the role for the names. See "TAG ENTRIES" | ||
section of :ref:`ctags(1) <ctags(1)>` about reference tags and roles. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not the output from ctags-lang-verilog.7.rst.in.
This is a true fail.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated. Thank you.
man/ctags-lang-verilog.7.rst.in
Outdated
The parsers extract modules names used in instance declarations as | ||
reference tags. ``decl`` is the role for the tags. See "TAG ENTRIES" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about:
The parser extracts module-names (or names of modules) used in instance declarations as reference tags.
We can say "The parsers extraces ...". If we choose this, we have to change other sentences in this manual.
The man page about SystemVerilog/Verilog parsers for Universal Ctags
This man page describes about the SystemVerilog/Verilog parsers for Universal Ctags.
I prefer singulars.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
…ce tags This one is conceptually based on universal-ctags/ctags@master...my2817:ctags:master reported and written by @my2817 at universal-ctags#3469. The test case is also taken from universal-ctags#3469 submitted by @my2817.
56f3ade
to
b2214c1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
This one is conceptually based on
master...my2817:ctags:master
reported and written by @my2817 at #3469.
The test case is also taken from #3469 submitted by @my2817.