code review 4670053: godoc: support for file systems stored in .zip files

godoc: support for file systems stored in .zip files

Instead of serving files of the underlying OS file system,
a .zip file may be provided to godoc containing the files
to serve; for instance:

   godoc -http=:6060 -zip=go.zip

using a .zip file created from a clean tree as follows:

   zip -r go.zip $GOROOT

[gri, 2011-07-13 23:32:47]

Hello rsc@golang.org (cc: golang-dev@googlegroups.com),

I'd like you to review this change to
https://go.googlecode.com/hg/

[rsc, 2011-07-13 23:54:27]

LGTM

Very nice.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go
File src/cmd/godoc/filesystem.go (right):

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:117: //
----------------------------------------------------------------------------
seems worth putting in zip.go instead of separating with banners

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:172: if !filepath.IsAbs(path) {
I suggest requiring / in the zip files and then use path instead of filepath
here.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:239: if i := strings.IndexRune(name,
filepath.Separator); i >= 0 {
// We infer directories from files in subdirectories.
// If we have x/y, return a directory entry for x.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:244: // There may be multiple local directories in
the current
// If we have x/y and x/z, don't return two directory entries for x.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:285: func (z zipList) lookup(name string) int {
worth a comment

// lookup returns the first position in the zip file of a path
// equal to name or beginning with name/.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/main.go
File src/cmd/godoc/main.go (right):

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/main.go#newcode52
src/cmd/godoc/main.go:52: // (with e.g.: zip -r go.zip $GOROOT -i \*.go -i
\*.html -i \*.css -i \*.js -i \*.txt -i \*.c -i \*.h -i \*.s -i \*.png -i \*.jpg
-i \*.sh)
it would be nice to just zip the whole thing.
as written you lose text files and perl scripts,
PDFs, and so on.  there's not much penalty
for putting more in the file.

[gri, 2011-07-14 18:33:01]

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go
File src/cmd/godoc/filesystem.go (right):

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:117: //
----------------------------------------------------------------------------
On 2011/07/13 23:54:27, rsc wrote:
> seems worth putting in zip.go instead of separating with banners

Done.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:172: if !filepath.IsAbs(path) {
On 2011/07/13 23:54:27, rsc wrote:
> I suggest requiring / in the zip files and then use path instead of filepath
> here.

Done.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:239: if i := strings.IndexRune(name,
filepath.Separator); i >= 0 {
On 2011/07/13 23:54:27, rsc wrote:
> // We infer directories from files in subdirectories.
> // If we have x/y, return a directory entry for x.

Done.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:244: // There may be multiple local directories in
the current
On 2011/07/13 23:54:27, rsc wrote:
> // If we have x/y and x/z, don't return two directory entries for x.

Done.

http://codereview.appspot.com/4670053/diff/11001/src/cmd/godoc/filesystem.go#...
src/cmd/godoc/filesystem.go:285: func (z zipList) lookup(name string) int {
On 2011/07/13 23:54:27, rsc wrote:
> worth a comment
> 
> // lookup returns the first position in the zip file of a path
> // equal to name or beginning with name/.
> 

Done.

[gri, 2011-07-14 18:34:57]

*** Submitted as http://code.google.com/p/go/source/detail?r=3e3f87ed3504 ***

godoc: support for file systems stored in .zip files

Instead of serving files of the underlying OS file system,
a .zip file may be provided to godoc containing the files
to serve; for instance:

   godoc -http=:6060 -zip=go.zip

using a .zip file created from a clean tree as follows:

   zip -r go.zip $GOROOT

R=rsc
CC=golang-dev
http://codereview.appspot.com/4670053