code review 201064: Ugly hack to provide some mechanism for printing docume...

Ugly hack to provide some mechanism for printing documentation about
Go source outside $GOROOT.

If the argument is a rooted path, disregard $GOROOT.  Also, disable the
check for package name matching the directory, which is counterproductive
in this case.

Apologies for the violence to the code but we need some help documenting
Go code outside the standard repository.

[r, 2010-02-05 06:20:19]

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

I'd like you to review this change.

[gri, 2010-02-05 07:08:48]

LGTM

Assuming this "works". Please mark the introduced sections more clearly, say
with //--- begin and end comments so I can recognize them easily.

- Robert

On Thu, Feb 4, 2010 at 10:20 PM, <r@golang.org> wrote:

> Reviewers: gri,
>
> Message:
> Hello gri (cc: golang-dev@googlegroups.com),
>
> I'd like you to review this change.
>
>
> Description:
> Ugly hack to provide some mechanism for printing documentation about
> Go source outside $GOROOT.
>
> If the argument is a rooted path, disregard $GOROOT.  Also, disable the
> check for package name matching the directory, which is
> counterproductive
> in this case.
>
> Apologies for the violence to the code but we need some help documenting
> Go code outside the standard repository.
>
> Please review this at http://codereview.appspot.com/201064/show
>
> Affected files:
>  M src/cmd/godoc/godoc.go
>
>
> Index: src/cmd/godoc/godoc.go
> ===================================================================
> --- a/src/cmd/godoc/godoc.go
> +++ b/src/cmd/godoc/godoc.go
> @@ -1043,8 +1043,15 @@
>  // PageInfo.Dirs is nil.
>  //
>  func (h *httpHandler) getPageInfo(path string, try bool) PageInfo {
> -       // the path is relative to h.fsroot
> -       dirname := pathutil.Join(h.fsRoot, path)
> +       var dirname string
> +       // If the path starts with a slash, ignore $GOROOT.
> +       // It would be nice to handle "./dir" too, but godoc chdirs to
> $GOROOT. TODO: fix.
> +       if len(path)>0 && path[0]=='/' {
> +                       dirname = path
> +       } else {
> +               // the path is relative to h.fsroot
> +               dirname = pathutil.Join(h.fsRoot, path)
> +       }
>
>        // the package name is the directory name within its parent
>        // (use dirname instead of path because dirname is clean; i.e. has
> no trailing '/')
> @@ -1053,6 +1060,12 @@
>        // filter function to select the desired .go files
>        filter := func(d *os.Dir) bool {
>                if isPkgFile(d) {
> +                       // First an ugly special case: If the path is
> rooted, just say
> +                       // yes in the hope we'll get some output from a
> directory
> +                       // outside $GOROOT.  Ugly but effective.
> +                       if len(path)>0 && path[0]=='/' {
> +                               return true
> +                       }
>                        // Some directories contain main packages: Only
> accept
>                        // files that belong to the expected package so that
>                        // parser.ParsePackage doesn't return "multiple
> packages
>
>
>

[r, 2010-02-05 09:36:40]

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

I'd like you to review this change.

[r2, 2010-02-05 09:37:14]

Hackery marked.

I also hacked a little more so 

	godoc .

works, which is great!

-rob

[r, 2010-02-05 21:53:52]

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

Ugly hack to provide some mechanism for printing documentation about
Go source outside $GOROOT.

If the argument is a path starting with / or ., disregard $GOROOT.
Also, disable the check for package name matching the directory,
which is counterproductive in this case.

Apologies for the violence to the code but we need some help documenting
Go code outside the standard repository.

R=gri
CC=golang-dev
http://codereview.appspot.com/201064

Committer: Rob Pike <r@golang.org>

[r, 2010-02-16 02:24:25]

*** Abandoned ***