diff options
Diffstat (limited to 'src/cmd/gotype/doc.go')
-rw-r--r-- | src/cmd/gotype/doc.go | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/src/cmd/gotype/doc.go b/src/cmd/gotype/doc.go new file mode 100644 index 000000000..ec4eb7c24 --- /dev/null +++ b/src/cmd/gotype/doc.go @@ -0,0 +1,59 @@ +// Copyright 2011 The Go Authors. All rights reserved. +// Use of this source code is governed by a BSD-style +// license that can be found in the LICENSE file. + +/* +The gotype command does syntactic and semantic analysis of Go files +and packages similar to the analysis performed by the front-end of +a Go compiler. Errors are reported if the analysis fails; otherwise +gotype is quiet (unless -v is set). + +Without a list of paths, gotype processes the standard input, which must +be the source of a single package file. + +Given a list of file names, each file must be a source file belonging to +the same package unless the package name is explicitly specified with the +-p flag. + +Given a directory name, gotype collects all .go files in the directory +and processes them as if they were provided as an explicit list of file +names. Each directory is processed independently. Files starting with . +or not ending in .go are ignored. + +Usage: + gotype [flags] [path ...] + +The flags are: + -p pkgName + process only those files in package pkgName. + -r + recursively process subdirectories. + -v + verbose mode. + +Debugging flags: + -trace + print parse trace (disables concurrent parsing). + -ast + print AST (disables concurrent parsing). + + +Examples + +To check the files file.go, old.saved, and .ignored: + + gotype file.go old.saved .ignored + +To check all .go files belonging to package main in the current directory +and recursively in all subdirectories: + + gotype -p main -r . + +To verify the output of a pipe: + + echo "package foo" | gotype + +*/ +package documentation + +// BUG(gri): At the moment, only single-file scope analysis is performed. |