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

x/tools/cmd/godoc: analysis mode is too hard/slow/fragile #8968

Open
bradfitz opened this Issue Oct 20, 2014 · 0 comments

Comments

Projects
None yet
2 participants
@bradfitz
Member

bradfitz commented Oct 20, 2014

I'm watching a friend trying to use godoc -analysis mode and it's apparent that there
are a few areas for improvement:

-- when a package has a parse error, just skip that package. Blake has $GOPATH=$HOME and
$HOME/src/** also has non-Go stuff, like Postgres. And Postgres has its own *.s files,
which aren't Go-style assembly. So godoc barfs.

-- analysis mode is too slow with a large GOPATH, and he has a large GOPATH. Our next
attempt was to make a new GOPATH just for godoc -analysis with symlinks to the subset of
packages we care about. But godoc and/or -analysis don't get along well with symlinks. 
So:

-- perhaps godoc needs its own -analysis-filter=[pattern] flag for a regexp or
comma-separated list of packages / globs (implicitly including all dependent packages
thereof).  e.g. --analysis-filter=foo.com/...,bar.com/baz,github.com/bradfitz/bar/...

-- log progress output in verbose mode? sometimes we think it's hung. Some reassuring
progress would be nice.

Thanks!

@bradfitz bradfitz added new labels Oct 20, 2014

@bradfitz bradfitz removed the new label Dec 18, 2014

@rsc rsc added this to the Unplanned milestone Apr 10, 2015

@rsc rsc removed the release-none label Apr 10, 2015

@rsc rsc changed the title from cmd/godoc: analysis mode is too hard/slow/fragile to x/tools/cmd/godoc: analysis mode is too hard/slow/fragile Apr 14, 2015

@rsc rsc removed the repo-tools label Apr 14, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment