code review 5689051: cmd/godoc: honor GOPATH and show user-code listings in ...

cmd/godoc: honor GOPATH and show user-code listings in html view.

This CL makes the following fixes:
- Show user paths in the html view for the top-level package listing.
  From $GOPATH,
  show commands (from src/cmd/*) under Commands view, and
  show all other packages (from src/*) under Packages view.
  This allows all source documentation to be found easily in godocs.
- Honor GOPATH logic, by adding GOPATH/src and GOPATH/src/cmd members into fsMap
- Resolve Symbolic links for directories put in GOPATH (so their docs can be seen)
  [we don't do infinite loop detection. It can easily be done if team wants it]

Fixes issue 2234.
Fixes issue 2605.
Fixes issue 3046.

[ugorji, 2012-02-20 21:11:02]

Hello golang-dev@googlegroups.com,

I'd like you to review this change to
https://code.google.com/p/go/

[ugorji, 2012-02-20 22:36:18]

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

Please take another look.

[remyoudompheng, 2012-02-22 21:53:05]

I don't really understand what the patch is doing. What happens if two GOPATH
elements contain the same prefix? e.g. one gopath contains github.com/aaa/foo
and another one contains github.com/bbb/bar: the exploration goes wrong, I would
have simply expected to see all available packages listed in the table of
contents, as it was before.

http://codereview.appspot.com/5689051/diff/3003/src/cmd/godoc/godoc.go
File src/cmd/godoc/godoc.go (right):

http://codereview.appspot.com/5689051/diff/3003/src/cmd/godoc/godoc.go#newcode97
src/cmd/godoc/godoc.go:97: func getFsMapPath(path string, info os.FileInfo)
(path2 string, err error) {
How is this function different from filepath.EvalSymlinks and what does it do?

[ugorji, 2012-02-22 23:16:14]

On 2012/02/22 21:53:05, remyoudompheng wrote:
> I don't really understand what the patch is doing. What happens if two GOPATH
> elements contain the same prefix? e.g. one gopath contains github.com/aaa/foo
> and another one contains github.com/bbb/bar: the exploration goes wrong, I
would
> have simply expected to see all available packages listed in the table of
> contents, as it was before.
> 

With this patch, In addition to contents of the -path parameter, we show all
top-level import-path prefixes found from $GOPATH, whereas before, you just saw
a src link. In addition, we show commands from $GOPATH/src/cmd, which were not
shown at all before.

> http://codereview.appspot.com/5689051/diff/3003/src/cmd/godoc/godoc.go
> File src/cmd/godoc/godoc.go (right):
> 
>
http://codereview.appspot.com/5689051/diff/3003/src/cmd/godoc/godoc.go#newcode97
> src/cmd/godoc/godoc.go:97: func getFsMapPath(path string, info os.FileInfo)
> (path2 string, err error) {
> How is this function different from filepath.EvalSymlinks and what does it do?

I'd look into using filepath.EvalSymlinks and follow up.

[ugorji, 2012-02-22 23:40:34]

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

Please take another look.

[ugorji, 2012-02-22 23:41:49]

On 2012/02/22 23:40:34, ugorji wrote:
I just updated the CL to use filepath.Evalsymlink. 

PTAL.

> Hello mailto:golang-dev@googlegroups.com, mailto:remyoudompheng@gmail.com (cc:
> mailto:golang-dev@googlegroups.com),
> 
> Please take another look.

[gri, 2012-02-22 23:42:59]

Thanks for doing this. I will take a look at this CLs once we have
decided what the correct solution is for this problem.
- gri

On Wed, Feb 22, 2012 at 3:41 PM,  <ugorji@gmail.com> wrote:
> On 2012/02/22 23:40:34, ugorji wrote:
> I just updated the CL to use filepath.Evalsymlink.
>
> PTAL.
>
>> Hello mailto:golang-dev@googlegroups.com,
>
> mailto:remyoudompheng@gmail.com (cc:
>>
>> mailto:golang-dev@googlegroups.com),
>
>
>> Please take another look.
>
>
>
>
> http://codereview.appspot.com/5689051/

[rsc, 2012-03-01 22:09:28]

Thanks for working on this, but I think more sweeping cleanup is needed.  I
created CL 5711058.

[ugorji, 2012-03-05 21:04:37]

*** Abandoned ***