A simple shell script to generate cscope index file for go

[Neo Liu]

Cscope also works for go language. So I just write a simple shell script to generate cscope index file for go.

The script can be downloaded from my github

https://github.com/diabloneo/linux-utils/blob/master/scripts/cscope-go.sh

Use this script is simple, too. Just run it under your project's root directory.

~/go/src/github.com/diabloneo/hello$ ll
total 4
-rw-r--r-- 1 diabloneo diabloneo 474 Apr 9 00:07 hello.go
~/go/src/github.com/diabloneo/hello$ echo $GOROOT
/opt/go
~/go/src/github.com/diabloneo/hello$ echo $GOPATH
/home/diabloneo/go
~/go/src/github.com/diabloneo/hello$ cscope-go.sh
Done
~/go/src/github.com/diabloneo/hello$ ll
total 7512
-rw-r--r-- 1 diabloneo diabloneo 49099 Apr 9 23:19 cscope.files
-rw-r--r-- 1 diabloneo diabloneo 7638765 Apr 9 23:19 cscope.out
-rw-r--r-- 1 diabloneo diabloneo 474 Apr 9 00:07 hello.go
~/go/src/github.com/diabloneo/hello$ cscope -d -l -0 LookupHost
/opt/go/src/pkg/net/hosts_test.go TestLookupHost 74 addrs, _ := LookupHost("localhost")
/opt/go/src/pkg/net/lookup.go LookupHost 24 func LookupHost(host string) (addrs []string, err error) {
/opt/go/src/pkg/net/lookup_plan9.go lookupIP 119 addrs, err := LookupHost(host)

And the content of the script:

#!/bin/bash
# generate cscope index files in current directory
# the generated cscope index files also include go standard packages
if [ $GOROOT = "" ]
then
    echo "GOROOT is not set"
    exit 1
fi
go_pkg_src=$GOROOT/src/pkg
find $go_pkg_src -name "*.go" -print > cscope.files
if cscope -b -k; then
    echo "Done"
else
    echo "Failed"
    exit 1
fi

Hope you like it.

[Aram Hăvărneanu]

Thanks, but Roger Peppe's godef is better because it's syntactic, not lexical:

http://godoc.org/code.google.com/p/rog-go/exp/cmd/godef

It works great in acme and if you don't use acme, there are vim/emacs
plugins distributed with the standard distribution.

--
Aram Hăvărneanu

[Neo Liu]

The original script missed one 'find' line.

 

#!/bin/bash

# generate cscope index files in current directory
# the generated cscope index files also include go standard packages

if [ $GOROOT = "" ]
then
    echo "GOROOT is not set"
    exit 1
fi

go_pkg_src=$GOROOT/src/pkg

find $go_pkg_src -name "*.go" -print > cscope.files

find . -name "*.go" -print >> cscope.files

[Neo Liu]

Yes, godef is better on find definition location, and works fine with https://github.com/dgryski/vim-godef plugin

But cscope can find strings with regexp. I think cscope and godef can work together.

[Tamás Gulácsi]

Don't require GOROOT to be set, instead use the output of "go env".