Source Code Browsing

A co-worker recommended GNU Global for browsing source code a few days ago. It was pretty easy to set up. Install it and then go to the root of your source tree and type gtags. Then you can run global on the command line and try it out. Try things like:

global funcName
global -x funcName
global -rx funcName
global -sx varName

That should give you the idea that it can find a function definition and all its references, or a variable name and all its references pretty quickly. Very handy.

There is an emacs interface as well. Load gtags.el (comes with global), open a file, and do M-x gtags-mode. c-h m will show you the commands gtags-mode provides for doing the same thing we just did on the command line.

I'm not sure if I'm going to switch to using global/gtags. I already use a combination of cscope and Exuberant ctags, both of which have their strengths, and both of which have emacs interfaces, naturally. They all seem to have troubles parsing out tags/symbols in my C++ code in various places, but for the most part they work well. My quick testing showed that GNU Globals did a little worse than what I'm already using using. You can see some issues it has here.

Overall, if you aren't already using a tool like this to help you browse your code (maybe you're using good ol' find and grep), I highly recommend picking up one (or more) of these tools. They are a lifesaver.

Comments

Anonymous said…
Note that git-grep makes find+grep-like usage insanely fast. It doesn't understand the code's structure, but it really blasts. (Then there's GNU idutils for snarfing some symbols. None of these really help for us Fortran guys, though.)
January 28, 2008 at 11:42 AM
Bryan said…
That reminds me, I should have mentioned that global/gtags can use idutils. I didn't try it though.
January 28, 2008 at 12:29 PM
Anonymous said…
Hi Bryan, it's Katie (Ily's cousin). I have a friend who recently posted a blog about his computer. It is all giberish to me but I thought maybe you could help him. He's looking for a motherboard or something like that. I gave him your blog, too. Talk to you soon (like two weeks!),
Katie.
http://qnacunningham.blogspot.com/
January 29, 2008 at 7:17 PM
Anonymous said…
Just another note, this is what Nate is looking for: dual processor Xeon board with PCI-Express

I only know one of those words! He he he
January 29, 2008 at 7:20 PM
Anonymous said…
Good words.
November 10, 2008 at 7:28 AM
Post a Comment

Popular posts from this blog

SystemVerilog Fork Disable "Gotchas"

This is a long post with a lot of SystemVerilog code. The purpose of this entry is to hopefully save you from beating your head against the wall trying to figure out some of the subtleties of SystemVerilog processes (basically, threads). Subtleties like these are commonly referred to in the industry as "Gotchas" which makes them sound so playful and fun, but they really aren't either. I encourage you to run these examples with your simulator (if you have access to one) so that a) you can see the results first hand and better internalize what's going on, and b) you can tell me in the comments if this code works fine for you and I'll know I should go complain to my simulator vendor. OK, I'll start with a warm-up that everyone who writes any Verilog or SystemVerilog at all should be aware of, tasks are static by default. If you do this: module top; task do_stuff ( int wait_time); #wait_time $display ( "waited %0d, then did stuff" , wa
Read more

'git revert' Is Not Equivalent To 'svn revert'

I just learned that if you have some changes in your working tree that you want to get rid of, you don't type 'git revert' like you might guess. No, that's what cvs, subversion, mercurial, and bazaar (to name a few) use revert to mean, but not git. With git, revert is used to undo actual commits. Thankfully, you can undo your revert with another 'git revert', I just learned. So let me repeat to be clear, if you have changes to your working files that you want to abandon, DO NOT do this: git revert HEAD That will undo your last commit. Do this instead: git reset --hard HEAD I'm glad I have that straightened out now. I'm wondering if /etc was really a good place for me to start out playing with git. UPDATE: Nearly two years later and I'm still getting comments on this. I'm glad I've been able to help people out this way. The discussion in the comments is good, and one thing I'd like to point out is that I now always use
Read more

Git Rebase Explained

Image
Introduction Rebase is a helpful git command that can be used to turn a branchy two-headed version history into an easy to follow linear one. A linear history is much easier for a human eye to follow and a human brain to understand. Rebase is a very safe command to use, despite some fear that people have about it. This post should explain how rebase works and clear up any misunderstandings about it. Rebase Basics The short summary of rebase is that it cuts commits out of the git history and reconnects them somewhere else. Let's say the common scenario comes up: you commit a change to the main branch of a repository, you then run  git fetch , and in come a couple changes that other people made on the main branch. If your commit is version 46f and the others that just came in on the fetch are versions ef9 and 4a2, your version history might look like this: The main branch now has two heads, 46f and 4a2. You can run  git rebase  to disconnect your commit from version d88 and connect i
Read more