close_issue_2
/
tools
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

go.tools/cmd/godex: update documentation 

LGTM=adonovan
R=adonovan
CC=golang-codereviews
https://golang.org/cl/83580046
This commit is contained in:
Robert Griesemer 2014-04-07 13:49:05 -07:00
parent 42a4cd3392
commit fa0f6bd591
1 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
cmd/godex/doc.go
View File

@ -17,18 +17,31 @@
// godex math // godex math
// godex math.Sin // godex math.Sin
// godex math.Sin fmt.Printf // godex math.Sin fmt.Printf
// godex go/types // godex go/types
// //
// All but the last path element may contain dots. godex automatically // godex automatically tries all possible package path prefixes if only a
// tries all possible package path prefixes for non-standard library // partial package path is given. For instance, for the path "go/types",
// packages if only a partial package path is given. For instance, for // godex prepends "code.google.com/p/go.tools".
// the path "go/types", godex prepends "code.google.com/p/go.tools".
// //
// The prefixes are computed by searching the directories specified by // The prefixes are computed by searching the directories specified by
// the GOPATH environment variable (and by excluding the build os and // the GOROOT and GOPATH environment variables (and by excluding the
// architecture specific directory names from the path). The search // build OS- and architecture-specific directory names from the path).
// order is depth-first and alphabetic; for a partial path "foo", a // The search order is depth-first and alphabetic; for a partial path
// package "a/foo" is found before "b/foo". // "foo", a package "a/foo" is found before "b/foo".
//
// Absolute and relative paths may be provided, which disable automatic
// prefix generation:
//
// godex $GOROOT/pkg/darwin_amd64/sort
// godex ./sort
//
// All but the last path element may contain dots; a dot in the last path
// element separates the package path from the package object name. If the
// last path element contains a dot, terminate the argument with another
// dot (indicating an empty object name). For instance, the path for a
// package foo.bar would be specified as in:
//
// godex foo.bar.
// //
// The flags are: // The flags are:
// //
@ -52,4 +65,5 @@
// //
package main package main
// BUG(gri) std-library packages should also benefit from auto-generated prefixes. // BUG(gri): support for -s=source is not yet implemented
// BUG(gri): gccgo-importing appears to have occasional problems stalling godex; try -s=gc as work-around