1
0
mirror of https://github.com/golang/go synced 2024-09-30 16:18:35 -06:00

tools: add import comments.

Change-Id: Idda6e64580432cb9a731e4ebf4005ee4ceb4202d
Reviewed-on: https://go-review.googlesource.com/1244
Reviewed-by: Andrew Gerrand <adg@golang.org>
This commit is contained in:
David Symonds 2014-12-09 15:00:58 +11:00 committed by Andrew Gerrand
parent 6e0e92af7e
commit 24257c8cd2
64 changed files with 64 additions and 64 deletions

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package astutil contains common utilities for working with the Go AST. // Package astutil contains common utilities for working with the Go AST.
package astutil package astutil // import "golang.org/x/tools/astutil"
import ( import (
"bufio" "bufio"

View File

@ -5,7 +5,7 @@
// Adapted from encoding/xml/read_test.go. // Adapted from encoding/xml/read_test.go.
// Package atom defines XML data structures for an Atom feed. // Package atom defines XML data structures for an Atom feed.
package atom package atom // import "golang.org/x/tools/blog/atom"
import ( import (
"encoding/xml" "encoding/xml"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package blog implements a web server for articles written in present format. // Package blog implements a web server for articles written in present format.
package blog package blog // import "golang.org/x/tools/blog"
import ( import (
"bytes" "bytes"

View File

@ -34,4 +34,4 @@ in a format like this:
BenchmarkConcat 80 48 -40.00% BenchmarkConcat 80 48 -40.00%
*/ */
package main package main // import "golang.org/x/tools/cmd/benchcmp"

View File

@ -4,7 +4,7 @@
// callgraph: a tool for reporting the call graph of a Go program. // callgraph: a tool for reporting the call graph of a Go program.
// See Usage for details, or run with -help. // See Usage for details, or run with -help.
package main package main // import "golang.org/x/tools/cmd/callgraph"
// TODO(adonovan): // TODO(adonovan):
// //

View File

@ -18,4 +18,4 @@ For usage information, please see:
go help testflag go help testflag
go tool cover -help go tool cover -help
*/ */
package main package main // import "golang.org/x/tools/cmd/cover"

View File

@ -12,7 +12,7 @@
// a comment syntax, etc. // a comment syntax, etc.
// - allow queries to nest, like Blaze query language. // - allow queries to nest, like Blaze query language.
// //
package main package main // import "golang.org/x/tools/cmd/digraph"
import ( import (
"bufio" "bufio"

View File

@ -1,7 +1,7 @@
// The eg command performs example-based refactoring. // The eg command performs example-based refactoring.
// For documentation, run the command, or see Help in // For documentation, run the command, or see Help in
// code.google.com/p/go.tools/refactor/eg. // code.google.com/p/go.tools/refactor/eg.
package main package main // import "golang.org/x/tools/cmd/eg"
import ( import (
"flag" "flag"

View File

@ -63,7 +63,7 @@
// //
// If no -s argument is provided, godex will try to find a matching source. // If no -s argument is provided, godex will try to find a matching source.
// //
package main package main // import "golang.org/x/tools/cmd/godex"
// BUG(gri): support for -s=source is not yet implemented // 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 // BUG(gri): gccgo-importing appears to have occasional problems stalling godex; try -s=gc as work-around

View File

@ -141,4 +141,4 @@ See "Godoc: documenting Go code" for how to write good comments for godoc:
http://golang.org/doc/articles/godoc_documenting_go_code.html http://golang.org/doc/articles/godoc_documenting_go_code.html
*/ */
package main package main // import "golang.org/x/tools/cmd/godoc"

View File

@ -30,4 +30,4 @@ For other editors, you probably know what to do.
Happy hacking! Happy hacking!
*/ */
package main package main // import "golang.org/x/tools/cmd/goimports"

View File

@ -1,7 +1,7 @@
// The gorename command performs precise type-safe renaming of // The gorename command performs precise type-safe renaming of
// identifiers in Go source code. See the -help message or Usage // identifiers in Go source code. See the -help message or Usage
// constant for details. // constant for details.
package main package main // import "golang.org/x/tools/cmd/gorename"
import ( import (
"flag" "flag"

View File

@ -59,4 +59,4 @@ To verify the output of a pipe:
echo "package foo" | gotype echo "package foo" | gotype
*/ */
package main package main // import "golang.org/x/tools/cmd/gotype"

View File

@ -4,7 +4,7 @@
// This program takes an HTML file and outputs a corresponding article file in // This program takes an HTML file and outputs a corresponding article file in
// present format. See: golang.org/x/tools/present // present format. See: golang.org/x/tools/present
package main package main // import "golang.org/x/tools/cmd/html2article"
import ( import (
"bufio" "bufio"

View File

@ -8,7 +8,7 @@
// //
// Run with -help flag or help subcommand for usage information. // Run with -help flag or help subcommand for usage information.
// //
package main package main // import "golang.org/x/tools/cmd/oracle"
import ( import (
"bufio" "bufio"

View File

@ -28,4 +28,4 @@ the generated output. The supported formats are:
The present file format is documented by the present package: The present file format is documented by the present package:
http://godoc.org/golang.org/x/tools/present http://godoc.org/golang.org/x/tools/present
*/ */
package main package main // import "golang.org/x/tools/cmd/present"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// ssadump: a tool for displaying and interpreting the SSA form of Go programs. // ssadump: a tool for displaying and interpreting the SSA form of Go programs.
package main package main // import "golang.org/x/tools/cmd/ssadump"
import ( import (
"flag" "flag"

View File

@ -56,7 +56,7 @@
// where t is the lower-cased name of the first type listed. It can be overridden // where t is the lower-cased name of the first type listed. It can be overridden
// with the -output flag. // with the -output flag.
// //
package main package main // import "golang.org/x/tools/cmd/stringer"
import ( import (
"bytes" "bytes"

View File

@ -179,4 +179,4 @@ These flags configure the behavior of vet:
-test -test
For testing only: sets -all and -shadow. For testing only: sets -all and -shadow.
*/ */
package main package main // import "golang.org/x/tools/cmd/vet"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package whitelist defines exceptions for the vet tool. // Package whitelist defines exceptions for the vet tool.
package whitelist package whitelist // import "golang.org/x/tools/cmd/vet/whitelist"
// UnkeyedLiteral are types that are actually slices, but // UnkeyedLiteral are types that are actually slices, but
// syntactically, we cannot tell whether the Typ in pkg.Typ{1, 2, 3} // syntactically, we cannot tell whether the Typ in pkg.Typ{1, 2, 3}

View File

@ -11,7 +11,7 @@
// map type. The IsEmpty, Min, Max, Clear and TakeMin operations // map type. The IsEmpty, Min, Max, Clear and TakeMin operations
// require constant time. // require constant time.
// //
package intsets package intsets // import "golang.org/x/tools/container/intsets"
// TODO(adonovan): // TODO(adonovan):
// - Add SymmetricDifference(x, y *Sparse), i.e. x ∆ y. // - Add SymmetricDifference(x, y *Sparse), i.e. x ∆ y.

View File

@ -4,7 +4,7 @@
// Package cover provides support for parsing coverage profiles // Package cover provides support for parsing coverage profiles
// generated by "go test -coverprofile=cover.out". // generated by "go test -coverprofile=cover.out".
package cover package cover // import "golang.org/x/tools/cover"
import ( import (
"bufio" "bufio"

View File

@ -55,4 +55,4 @@ If the Google Code credentials are not provided the archival step
will be skipped. will be skipped.
*/ */
package main package main // import "golang.org/x/tools/dashboard/builder"

View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
package main package main // import "golang.org/x/tools/dashboard/coordinator/buildongce"
import ( import (
"bufio" "bufio"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// The coordinator runs on GCE and coordinates builds in Docker containers. // The coordinator runs on GCE and coordinates builds in Docker containers.
package main package main // import "golang.org/x/tools/dashboard/coordinator"
import ( import (
"bytes" "bytes"

View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
package main package main // import "golang.org/x/tools/dashboard/updater"
import ( import (
"bytes" "bytes"

View File

@ -4,7 +4,7 @@
// Command watcher watches the specified repository for new commits // Command watcher watches the specified repository for new commits
// and reports them to the build dashboard. // and reports them to the build dashboard.
package main package main // import "golang.org/x/tools/dashboard/watcher"
import ( import (
"bytes" "bytes"

View File

@ -7,7 +7,7 @@
// //
// All I/O is done via the build.Context file system interface, which must // All I/O is done via the build.Context file system interface, which must
// be concurrency-safe. // be concurrency-safe.
package buildutil package buildutil // import "golang.org/x/tools/go/buildutil"
import ( import (
"go/build" "go/build"

View File

@ -32,7 +32,7 @@ in the call graph; they are treated like built-in operators of the
language. language.
*/ */
package callgraph package callgraph // import "golang.org/x/tools/go/callgraph"
// TODO(adonovan): add a function to eliminate wrappers from the // TODO(adonovan): add a function to eliminate wrappers from the
// callgraph, preserving topology. // callgraph, preserving topology.

View File

@ -17,7 +17,7 @@
// and all concrete types are put into interfaces, it is sound to run on // and all concrete types are put into interfaces, it is sound to run on
// partial programs, such as libraries without a main or test function. // partial programs, such as libraries without a main or test function.
// //
package cha package cha // import "golang.org/x/tools/go/callgraph/cha"
import ( import (
"golang.org/x/tools/go/callgraph" "golang.org/x/tools/go/callgraph"

View File

@ -40,7 +40,7 @@
// cmd/callgraph tool on its own source takes ~2.1s for RTA and ~5.4s // cmd/callgraph tool on its own source takes ~2.1s for RTA and ~5.4s
// for points-to analysis. // for points-to analysis.
// //
package rta package rta // import "golang.org/x/tools/go/callgraph/rta"
// TODO(adonovan): test it by connecting it to the interpreter and // TODO(adonovan): test it by connecting it to the interpreter and
// replacing all "unreachable" functions by a special intrinsic, and // replacing all "unreachable" functions by a special intrinsic, and

View File

@ -1,6 +1,6 @@
// Package static computes the call graph of a Go program containing // Package static computes the call graph of a Go program containing
// only static call edges. // only static call edges.
package static package static // import "golang.org/x/tools/go/callgraph/static"
import ( import (
"golang.org/x/tools/go/callgraph" "golang.org/x/tools/go/callgraph"

View File

@ -11,7 +11,7 @@
// values produce unknown values unless specified // values produce unknown values unless specified
// otherwise. // otherwise.
// //
package exact package exact // import "golang.org/x/tools/go/exact"
import ( import (
"fmt" "fmt"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package gccgoimporter implements Import for gccgo-generated object files. // Package gccgoimporter implements Import for gccgo-generated object files.
package gccgoimporter package gccgoimporter // import "golang.org/x/tools/go/gccgoimporter"
import ( import (
"bytes" "bytes"

View File

@ -4,7 +4,7 @@
// Package gcimporter implements Import for gc-generated object files. // Package gcimporter implements Import for gc-generated object files.
// Importing this package installs Import as go/types.DefaultImport. // Importing this package installs Import as go/types.DefaultImport.
package gcimporter package gcimporter // import "golang.org/x/tools/go/gcimporter"
import ( import (
"bufio" "bufio"

View File

@ -7,7 +7,7 @@
// by R. Griesemer, Technical Report 156, ETH Zürich, 1991. // by R. Griesemer, Technical Report 156, ETH Zürich, 1991.
// package importer implements an exporter and importer for Go export data. // package importer implements an exporter and importer for Go export data.
package importer package importer // import "golang.org/x/tools/go/importer"
import ( import (
"encoding/binary" "encoding/binary"

View File

@ -73,7 +73,7 @@
// DEPENDENCY is a package loaded to satisfy an import in an initial // DEPENDENCY is a package loaded to satisfy an import in an initial
// package or another dependency. // package or another dependency.
// //
package loader package loader // import "golang.org/x/tools/go/loader"
// 'go test', in-package test files, and import cycles // 'go test', in-package test files, and import cycles
// --------------------------------------------------- // ---------------------------------------------------

View File

@ -607,4 +607,4 @@ ACM, New York, NY, USA, 47-56. DOI=10.1145/349299.349310
http://doi.acm.org/10.1145/349299.349310 http://doi.acm.org/10.1145/349299.349310
*/ */
package pointer package pointer // import "golang.org/x/tools/go/pointer"

View File

@ -120,4 +120,4 @@
// domains of source locations, ast.Nodes, types.Objects, // domains of source locations, ast.Nodes, types.Objects,
// ssa.Values/Instructions. // ssa.Values/Instructions.
// //
package ssa package ssa // import "golang.org/x/tools/go/ssa"

View File

@ -42,7 +42,7 @@
// //
// * os.Exit is implemented using panic, causing deferred functions to // * os.Exit is implemented using panic, causing deferred functions to
// run. // run.
package interp package interp // import "golang.org/x/tools/go/ssa/interp"
import ( import (
"fmt" "fmt"

View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
package ssautil package ssautil // import "golang.org/x/tools/go/ssa/ssautil"
import "golang.org/x/tools/go/ssa" import "golang.org/x/tools/go/ssa"

View File

@ -20,7 +20,7 @@
// and checks for compliance with the language specification. // and checks for compliance with the language specification.
// Use Info.Types[expr].Type for the results of type inference. // Use Info.Types[expr].Type for the results of type inference.
// //
package types package types // import "golang.org/x/tools/go/types"
import ( import (
"bytes" "bytes"

View File

@ -4,7 +4,7 @@
// Package typeutil defines various utilities for types, such as Map, // Package typeutil defines various utilities for types, such as Map,
// a mapping from types.Type to interface{} values. // a mapping from types.Type to interface{} values.
package typeutil package typeutil // import "golang.org/x/tools/go/types/typeutil"
import ( import (
"bytes" "bytes"

View File

@ -2,7 +2,7 @@
// Use of this source code is governed by a BSD-style // Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
package vcs package vcs // import "golang.org/x/tools/go/vcs"
import ( import (
"bytes" "bytes"

View File

@ -40,7 +40,7 @@
// location is highlighted in red and hover text provides the compiler // location is highlighted in red and hover text provides the compiler
// error message. // error message.
// //
package analysis package analysis // import "golang.org/x/tools/godoc/analysis"
import ( import (
"fmt" "fmt"

View File

@ -7,7 +7,7 @@
// //
// This package comment will evolve over time as this package splits // This package comment will evolve over time as this package splits
// into smaller pieces. // into smaller pieces.
package godoc package godoc // import "golang.org/x/tools/godoc"
import ( import (
"bytes" "bytes"

View File

@ -5,7 +5,7 @@
// Package redirect provides hooks to register HTTP handlers that redirect old // Package redirect provides hooks to register HTTP handlers that redirect old
// godoc paths to their new equivalents and assist in accessing the issue // godoc paths to their new equivalents and assist in accessing the issue
// tracker, wiki, code review system, etc. // tracker, wiki, code review system, etc.
package redirect package redirect // import "golang.org/x/tools/godoc/redirect"
import ( import (
"net/http" "net/http"

View File

@ -5,4 +5,4 @@
// Package static exports a map of static file content that supports the godoc // Package static exports a map of static file content that supports the godoc
// user interface. The map should be used with the mapfs package, see // user interface. The map should be used with the mapfs package, see
// golang.org/x/tools/godoc/vfs/mapfs. // golang.org/x/tools/godoc/vfs/mapfs.
package static package static // import "golang.org/x/tools/godoc/static"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package util contains utility types and functions for godoc. // Package util contains utility types and functions for godoc.
package util package util // import "golang.org/x/tools/godoc/util"
import ( import (
pathpkg "path" pathpkg "path"

View File

@ -4,7 +4,7 @@
// Package gatefs provides an implementation of the FileSystem // Package gatefs provides an implementation of the FileSystem
// interface that wraps another FileSystem and limits its concurrency. // interface that wraps another FileSystem and limits its concurrency.
package gatefs package gatefs // import "golang.org/x/tools/godoc/vfs/gatefs"
import ( import (
"fmt" "fmt"

View File

@ -3,7 +3,7 @@
// license that can be found in the LICENSE file. // license that can be found in the LICENSE file.
// Package httpfs implements http.FileSystem using a godoc vfs.FileSystem. // Package httpfs implements http.FileSystem using a godoc vfs.FileSystem.
package httpfs package httpfs // import "golang.org/x/tools/godoc/vfs/httpfs"
import ( import (
"fmt" "fmt"

View File

@ -4,7 +4,7 @@
// Package mapfs file provides an implementation of the FileSystem // Package mapfs file provides an implementation of the FileSystem
// interface based on the contents of a map[string]string. // interface based on the contents of a map[string]string.
package mapfs package mapfs // import "golang.org/x/tools/godoc/vfs/mapfs"
import ( import (
"io" "io"

View File

@ -4,7 +4,7 @@
// Package vfs defines types for abstract file system access and provides an // Package vfs defines types for abstract file system access and provides an
// implementation accessing the file system of the underlying OS. // implementation accessing the file system of the underlying OS.
package vfs package vfs // import "golang.org/x/tools/godoc/vfs"
import ( import (
"io" "io"

View File

@ -15,7 +15,7 @@
// like absolute paths w/o a leading '/'; i.e., the paths are considered // like absolute paths w/o a leading '/'; i.e., the paths are considered
// relative to the root of the file system. // relative to the root of the file system.
// - All path arguments to file system methods must be absolute paths. // - All path arguments to file system methods must be absolute paths.
package zipfs package zipfs // import "golang.org/x/tools/godoc/vfs/zipfs"
import ( import (
"archive/zip" "archive/zip"

View File

@ -4,7 +4,7 @@
// Package imports implements a Go pretty-printer (like package "go/format") // Package imports implements a Go pretty-printer (like package "go/format")
// that also adds or removes import statements as necessary. // that also adds or removes import statements as necessary.
package imports package imports // import "golang.org/x/tools/imports"
import ( import (
"bufio" "bufio"

View File

@ -8,7 +8,7 @@
// http://golang.org/s/oracle-design // http://golang.org/s/oracle-design
// http://golang.org/s/oracle-user-manual // http://golang.org/s/oracle-user-manual
// //
package oracle package oracle // import "golang.org/x/tools/oracle"
// This file defines oracle.Query, the entry point for the oracle tool. // This file defines oracle.Query, the entry point for the oracle tool.
// The actual executable is defined in cmd/oracle. // The actual executable is defined in cmd/oracle.

View File

@ -5,7 +5,7 @@
// Package playground registers HTTP handlers at "/compile" and "/share" that // Package playground registers HTTP handlers at "/compile" and "/share" that
// proxy requests to the golang.org playground service. // proxy requests to the golang.org playground service.
// This package may be used unaltered on App Engine. // This package may be used unaltered on App Engine.
package playground package playground // import "golang.org/x/tools/playground"
import ( import (
"bytes" "bytes"

View File

@ -11,7 +11,7 @@
// The wire format is JSON and is described by the Message type. // The wire format is JSON and is described by the Message type.
// //
// This will not run on App Engine as WebSockets are not supported there. // This will not run on App Engine as WebSockets are not supported there.
package socket package socket // import "golang.org/x/tools/playground/socket"
import ( import (
"bytes" "bytes"

View File

@ -202,4 +202,4 @@ It is your responsibilty to make sure the included HTML is valid and safe.
.html file.html .html file.html
*/ */
package present package present // import "golang.org/x/tools/present"

View File

@ -1,6 +1,6 @@
// Package eg implements the example-based refactoring tool whose // Package eg implements the example-based refactoring tool whose
// command-line is defined in golang.org/x/tools/cmd/eg. // command-line is defined in golang.org/x/tools/cmd/eg.
package eg package eg // import "golang.org/x/tools/refactor/eg"
import ( import (
"bytes" "bytes"

View File

@ -4,7 +4,7 @@
// Package importgraph computes the forward and reverse import // Package importgraph computes the forward and reverse import
// dependency graphs for all packages in a Go workspace. // dependency graphs for all packages in a Go workspace.
package importgraph package importgraph // import "golang.org/x/tools/refactor/importgraph"
import ( import (
"go/build" "go/build"

View File

@ -9,7 +9,7 @@
// //
// THIS INTERFACE IS EXPERIMENTAL AND MAY CHANGE OR BE REMOVED IN FUTURE. // THIS INTERFACE IS EXPERIMENTAL AND MAY CHANGE OR BE REMOVED IN FUTURE.
// //
package lexical package lexical // import "golang.org/x/tools/refactor/lexical"
// OVERVIEW // OVERVIEW
// //

View File

@ -5,7 +5,7 @@
// Package rename contains the implementation of the 'gorename' command // Package rename contains the implementation of the 'gorename' command
// whose main function is in golang.org/x/tools/refactor/rename. // whose main function is in golang.org/x/tools/refactor/rename.
// See that package for the command documentation. // See that package for the command documentation.
package rename package rename // import "golang.org/x/tools/refactor/rename"
import ( import (
"errors" "errors"

View File

@ -15,7 +15,7 @@
// since it is computing it anyway, and it is robust for ill-typed // since it is computing it anyway, and it is robust for ill-typed
// inputs, which this package is not. // inputs, which this package is not.
// //
package satisfy package satisfy // import "golang.org/x/tools/refactor/satisfy"
// NOTES: // NOTES:
// //