code review 206078: godoc support for directories outside $GOROOT

godoc support for directories outside $GOROOT

Example use: godoc -path=/home/user1:/home/build/foo -http=:6666
will start a local godoc that maps urls starting with /pkg/user1 or
/pkg/foo to the respective roots specified in the path.

Missing: Handling of overlapping package directories, multiple
packages per directory.

[gri, 2010-02-12 01:14:40]

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

I'd like you to review this change.

[gri, 2010-02-12 01:21:40]

PS: A version of this godoc is running at:

http://r45:6080/

with -path=/home/build/google3

The root page shows extra links for path entries.
- Robert

On Thu, Feb 11, 2010 at 5:14 PM, <gri@golang.org> wrote:

> Reviewers: rsc,
>
> Message:
> Hello rsc (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> godoc support for directories outside $GOROOT
>
> Example use: godoc -path=/home/gri:/home/build/google3 -http=:6666
> will start a local godoc that maps urls starting with /pkg/gri or
> /pkg/google3 to the respective roots specified in the path.
>
> Missing: Handling of overlapping package directories, multiple
> packages per directory.
>
> Please review this at http://codereview.appspot.com/206078/show
>
> Affected files:
>  A lib/godoc/error.html
>  M lib/godoc/godoc.html
>  M lib/godoc/package.html
>  M lib/godoc/search.html
>  R lib/godoc/source.html
>  M src/cmd/godoc/Makefile
>  M src/cmd/godoc/godoc.go
>  M src/cmd/godoc/main.go
>  M src/cmd/godoc/mapping.go
>
>
>

[gri, 2010-02-16 18:15:53]

ping

On Thu, Feb 11, 2010 at 5:14 PM,  <gri@golang.org> wrote:
> Reviewers: rsc,
>
> Message:
> Hello rsc (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> godoc support for directories outside $GOROOT
>
> Example use: godoc -path=/home/gri:/home/build/google3 -http=:6666
> will start a local godoc that maps urls starting with /pkg/gri or
> /pkg/google3 to the respective roots specified in the path.
>
> Missing: Handling of overlapping package directories, multiple
> packages per directory.
>
> Please review this at http://codereview.appspot.com/206078/show
>
> Affected files:
>  A lib/godoc/error.html
>  M lib/godoc/godoc.html
>  M lib/godoc/package.html
>  M lib/godoc/search.html
>  R lib/godoc/source.html
>  M src/cmd/godoc/Makefile
>  M src/cmd/godoc/godoc.go
>  M src/cmd/godoc/main.go
>  M src/cmd/godoc/mapping.go
>
>
>

[rsc, 2010-02-16 18:28:01]

http://codereview.appspot.com/206078/diff/52/55
File lib/godoc/package.html (right):

http://codereview.appspot.com/206078/diff/52/55#newcode19
lib/godoc/package.html:19: <a href="{@|url-src}">{@|url-src}</a><br />
Looks like this is going to print the full path as the link text.
The old code printed just the last element.

[gri, 2010-02-16 18:35:19]

On Tue, Feb 16, 2010 at 10:28 AM,  <rsc@golang.org> wrote:
>
> http://codereview.appspot.com/206078/diff/52/55
> File lib/godoc/package.html (right):
>
> http://codereview.appspot.com/206078/diff/52/55#newcode19
> lib/godoc/package.html:19: <a href="{@|url-src}">{@|url-src}</a><br />
> Looks like this is going to print the full path as the link text.
> The old code printed just the last element.
>
> http://codereview.appspot.com/206078/show
>

Correct. It's on purpose. Now that a package (potentially) can be made
up of files from different directories (at least for the purposes of
godoc, and also because the compilers simply take a list of files), it
is important to see the full (relative) path.

- Robert

[gri, 2010-02-16 19:03:15]

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

Please take another look.

[rsc, 2010-02-16 19:18:43]

LGTM

[gri, 2010-02-16 19:20:58]

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

godoc support for directories outside $GOROOT

Example use: godoc -path=/home/user1:/home/build/foo -http=:6666
will start a local godoc that maps urls starting with /pkg/user1 or
/pkg/foo to the respective roots specified in the path.

Missing: Handling of overlapping package directories, multiple
packages per directory.

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