mirror of
https://github.com/golang/go
synced 2024-10-01 06:28:35 -06:00
f595fb5c96
Prior to this change, handlerServer.GetPageInfo created a build.Context starting with build.Default, and provided custom implementations for its IsAbsPath, ReadDir, and OpenFile funcs. Those funcs would operate on h.c.fs virtual filesystem. https://godoc.org/go/build#Context.IsDir is documented as: // IsDir reports whether the path names a directory. // If IsDir is nil, Import calls os.Stat and uses the result's IsDir method. IsDir func(path string) bool IsDir was left as nil, and so the default implementation was used. The default implementation uses os.Stat and isn't aware of the h.c.fs virtual filesystem. This appears to have been harmless in the past, but after the change to go/build in https://golang.org/cl/33158, it started to interfere with the operation of godoc. The command godoc began to fail to resolve relative import path "." in directories that exist, because the incorrect IsDir implementation was looking in real filesystem, rather than the virtual one: $ ./godoc fmt 2017/03/04 18:59:50 cannot find package "." in: /target $ ./godoc -http=localhost:6060 2017/03/04 19:00:07 cannot find package "." in: /src/fmt Providing a custom implementation of IsDir that is aware of the h.c.fs virtual filesystem, and performs a stat operation on the correct path there resolves that problem. It also fixes the failing tests. Additionally, because the exact error string returned from Context.Import has changed after https://golang.org/cl/33158, and now contains the text "package not found" rather than the underlying error text from filesystem caused by a failed ReadDir operation, the expected error message from "./godoc nonexistingpkg" in a test needed to be updated to "cannot find package". It's no longer dependent on the operating system. It might be desirable to provide more relevant detail in the error message from cmd/godoc when a package is not found, but that should be determined and done in a followup CL. The scope of this one is to fix normal functionality. This change follows update to go/build in https://golang.org/cl/33158. Helps golang/go#19401. Change-Id: I00e2f746ec4a2fe7e640218adce75f15bdf29aaf Reviewed-on: https://go-review.googlesource.com/37768 Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> |
||
|---|---|---|
| .. | ||
| analysis | ||
| dl | ||
| proxy | ||
| redirect | ||
| short | ||
| static | ||
| util | ||
| vfs | ||
| appengine.go | ||
| cmdline_test.go | ||
| cmdline.go | ||
| corpus.go | ||
| dirtrees.go | ||
| format.go | ||
| godoc17_test.go | ||
| godoc_test.go | ||
| godoc.go | ||
| index_test.go | ||
| index.go | ||
| linkify.go | ||
| meta.go | ||
| page.go | ||
| parser.go | ||
| pres.go | ||
| README.md | ||
| search.go | ||
| server.go | ||
| snippet.go | ||
| spec.go | ||
| spot.go | ||
| tab.go | ||
| template.go | ||
godoc
This directory contains most of the code for running a godoc server. The executable lives at golang.org/x/tools/cmd/godoc.
Development mode
In production, CSS/JS/template assets need to be compiled into the godoc binary. It can be tedious to recompile assets every time, but you can pass a flag to load CSS/JS/templates from disk every time a page loads:
godoc --templates=$GOPATH/src/golang.org/x/tools/godoc/static --http=:6060
Recompiling static assets
The files that live at static/style.css, static/jquery.js and so on are not
present in the final binary. They are placed into static/static.go by running
go generate. So to compile a change and test it in your browser:
-
Make changes to e.g.
static/style.css. -
Run
go generate golang.org/x/tools/godoc/staticsostatic/static.gopicks up the change. -
Run
go install golang.org/x/tools/cmd/godocso the compiledgodocbinary picks up the change. -
Run
godoc -http=:6060and view your changes in the browser. You may need to disable your browser's cache to avoid reloading a stale file.