Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
Tor
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Benjamin J. Thompson
Tor
Commits
e08d0769
Commit
e08d0769
authored
5 years ago
by
Nick Mathewson
Browse files
Options
Downloads
Patches
Plain Diff
Add documentation about building a TAGS file.
Patch from opara. Closes ticket 32779.
parent
1f498220
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
changes/ticket32779
+3
-0
3 additions, 0 deletions
changes/ticket32779
doc/HACKING/HelpfulTools.md
+24
-0
24 additions, 0 deletions
doc/HACKING/HelpfulTools.md
with
27 additions
and
0 deletions
changes/ticket32779
0 → 100644
+
3
−
0
View file @
e08d0769
o Documentation:
- Add documentation in 'HelpfulTools.md' to describe how to build a tag
file. Closes ticket 32779.
This diff is collapsed.
Click to expand it.
doc/HACKING/HelpfulTools.md
+
24
−
0
View file @
e08d0769
...
...
@@ -315,6 +315,30 @@ If you use emacs for editing Tor and nothing else, you could always just say:
There is probably a better way to do this. No, we are probably not going
to clutter the files with emacs stuff.
Building a tag file (code index)
--------------------------------
Many functions in tor use
`MOCK_IMPL`
wrappers for unit tests. Your
tag-building program must be told how to handle this syntax.
If you're using emacs, you can generate an emacs-compatible tag file using
`make tags`
. This will run your system's
`etags`
. Tor's build system assumes
that you're using the emacs-specific version of
`etags`
(bundled under the
`xemacs21-bin`
package on Debian). This is incompatible with other versions of
`etags`
such as the version provided by Exuberant Ctags.
If you're using vim or emacs, you can also use Universal Ctags to build a tag
file using the syntax:
ctags -R -D 'MOCK_IMPL(r,h,a)=r h a' .
If you're using an older version of Universal Ctags, you can use the following
instead:
ctags -R --mline-regex-c='/MOCK_IMPL\([^,]+,\W*([a-zA-Z0-9_]+)\W*,/\1/f/{mgroup=1}' .
A vim-compatible tag file will be generated by default. If you use emacs, add
the
`-e`
flag to generate an emacs-compatible tag file.
Doxygen
-------
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment