From fa0f6bd59195173d3a9806dbff554e9654cbb810 Mon Sep 17 00:00:00 2001
From: Robert Griesemer <gri@golang.org>
Date: Mon, 7 Apr 2014 13:49:05 -0700
Subject: [PATCH] go.tools/cmd/godex: update documentation

LGTM=adonovan
R=adonovan
CC=golang-codereviews
https://golang.org/cl/83580046
---
 cmd/godex/doc.go | 34 ++++++++++++++++++++++++----------
 1 file changed, 24 insertions(+), 10 deletions(-)

diff --git a/cmd/godex/doc.go b/cmd/godex/doc.go
index ac14eb77..cf17c6ae 100644
--- a/cmd/godex/doc.go
+++ b/cmd/godex/doc.go
@@ -17,18 +17,31 @@
 //	godex math
 //	godex math.Sin
 //	godex math.Sin fmt.Printf
-//      godex go/types
+//	godex go/types
 //
-// All but the last path element may contain dots. godex automatically
-// tries all possible package path prefixes for non-standard library
-// packages if only a partial package path is given. For instance, for
-// the path "go/types", godex prepends "code.google.com/p/go.tools".
+// godex automatically tries all possible package path prefixes if only a
+// partial package path is given. For instance, for the path "go/types",
+// godex prepends "code.google.com/p/go.tools".
 //
 // The prefixes are computed by searching the directories specified by
-// the GOPATH environment variable (and by excluding the build os and
-// architecture specific directory names from the path). The search
-// order is depth-first and alphabetic; for a partial path "foo", a
-// package "a/foo" is found before "b/foo".
+// the GOROOT and GOPATH environment variables (and by excluding the
+// build OS- and architecture-specific directory names from the path).
+// The search order is depth-first and alphabetic; for a partial path
+// "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:
 //
@@ -52,4 +65,5 @@
 //
 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