Skip to content

x/pkgsite: list main programs / commands separately from other packages #3199

@ugorji

Description

@ugorji
This is a follow-up to the really nice update from Russ with CL:
http://golang.org/cl/5711058/

It will be nice to separate user ($GOPATH) commands from packages in directory listing.
One way to do this is to show user commands (from $GOPATH/src/cmd/*) in Commands view,
and not in Packages view.

godoc currently handles user packages found in $GOPATH nicely, by putting user packages
alongside built-in packages, so one sees all the packages available to him.

In the same vein, it will be nice if godoc can handle commands, by putting user commands
alongside built-in commands. 

For example, suppose you have:
  $GOPATH/src/{pkg1...n}
  $GOPATH/src/cmd/{cmd1...n}

It will be nice if godoc skips showing anything under src/cmd in the
"Packages" view (ie skip cmd/{cmd1...n}), and show stuff under src/cmd/
({cmd1...n}) in the "Commands" view. 

Currently, I see my commands in the Packages view, and the import line is wrong, and
there's really no extra information it gives, since I can't use the command code in any
other packages (so it ends up adding clutter).

To illustrate further, in my codebase, when I run godoc, I see my commands somewhere in
the middle of the pack, below my b###.net/* and bytes packages and before
code.google.com/* packages. It's very easy to miss (especially with the comfortable
spacing style), and you wouldn't realize those are not actually packages, but commands.
I then click the "Commands" link where I'd expect to see them, but see only
the standard ones (like go, gofmt, vet, yacc, etc). 

(This suggestion is limited to godoc alone; the definition of $GOPATH and its
interaction with go command shouldn't be affected)

##################### DETOUR ######################
It will also be nice if there's a quick link above Packages/Commands views to:
  .. (up one directory level) 
  Packages
  Commands

Currently, the .. is way at the bottom (along with Sub Directories), and to get to
Packages or Commands listing, you have to click References at the top and start over.


Which compiler are you using (5g, 6g, 8g, gccgo)?
6g

Which operating system are you using?
Linux

Which revision are you using?  (hg identify)
ba91b34fe212+ tip

Please provide any additional information below.

Metadata

Metadata

Assignees

No one assigned

    Labels

    NeedsInvestigationSomeone must examine and confirm this is a valid issue and not a duplicate of an existing one.pkgsite

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions