]> Cypherpunks repositories - gostls13.git/commitdiff
src/pkg: make package doc comments consistently start with "Package foo".
authorNigel Tao <nigeltao@golang.org>
Tue, 19 Apr 2011 23:57:05 +0000 (09:57 +1000)
committerNigel Tao <nigeltao@golang.org>
Tue, 19 Apr 2011 23:57:05 +0000 (09:57 +1000)
R=rsc
CC=golang-dev
https://golang.org/cl/4442064

109 files changed:
doc/effective_go.html
src/pkg/archive/tar/common.go
src/pkg/archive/zip/reader.go
src/pkg/asn1/asn1.go
src/pkg/big/nat.go
src/pkg/bufio/bufio.go
src/pkg/bytes/bytes.go
src/pkg/cmath/abs.go
src/pkg/compress/flate/inflate.go
src/pkg/compress/gzip/gunzip.go
src/pkg/compress/lzw/reader.go
src/pkg/compress/zlib/reader.go
src/pkg/container/heap/heap.go
src/pkg/container/list/list.go
src/pkg/container/ring/ring.go
src/pkg/container/vector/defs.go
src/pkg/crypto/aes/const.go
src/pkg/crypto/blowfish/cipher.go
src/pkg/crypto/cast5/cast5.go
src/pkg/crypto/cipher/cipher.go
src/pkg/crypto/crypto.go
src/pkg/crypto/elliptic/elliptic.go
src/pkg/crypto/hmac/hmac.go
src/pkg/crypto/md4/md4.go
src/pkg/crypto/md5/md5.go
src/pkg/crypto/ocsp/ocsp.go
src/pkg/crypto/openpgp/armor/armor.go
src/pkg/crypto/openpgp/error/error.go
src/pkg/crypto/openpgp/packet/packet.go
src/pkg/crypto/openpgp/read.go
src/pkg/crypto/openpgp/s2k/s2k.go
src/pkg/crypto/rc4/rc4.go
src/pkg/crypto/ripemd160/ripemd160.go
src/pkg/crypto/rsa/rsa.go
src/pkg/crypto/sha1/sha1.go
src/pkg/crypto/sha256/sha256.go
src/pkg/crypto/sha512/sha512.go
src/pkg/crypto/subtle/constant_time.go
src/pkg/crypto/tls/tls.go
src/pkg/crypto/twofish/twofish.go
src/pkg/crypto/x509/x509.go
src/pkg/crypto/xtea/cipher.go
src/pkg/debug/dwarf/open.go
src/pkg/ebnf/ebnf.go
src/pkg/encoding/hex/hex.go
src/pkg/encoding/line/line.go
src/pkg/encoding/pem/pem.go
src/pkg/exec/exec.go
src/pkg/exp/datafmt/datafmt.go
src/pkg/exp/draw/x11/conn.go
src/pkg/exp/eval/world.go
src/pkg/exp/ogle/cmd.go
src/pkg/expvar/expvar.go
src/pkg/flag/flag.go
src/pkg/go/ast/ast.go
src/pkg/go/doc/doc.go
src/pkg/go/parser/parser.go
src/pkg/go/printer/printer.go
src/pkg/go/scanner/scanner.go
src/pkg/go/token/token.go
src/pkg/go/types/types.go
src/pkg/gob/doc.go
src/pkg/hash/adler32/adler32.go
src/pkg/hash/crc32/crc32.go
src/pkg/hash/crc64/crc64.go
src/pkg/hash/fnv/fnv.go
src/pkg/hash/hash.go
src/pkg/html/doc.go
src/pkg/http/httptest/recorder.go
src/pkg/http/request.go
src/pkg/image/image.go
src/pkg/image/png/reader.go
src/pkg/image/ycbcr/ycbcr.go
src/pkg/index/suffixarray/suffixarray.go
src/pkg/io/io.go
src/pkg/io/ioutil/ioutil.go
src/pkg/json/encode.go
src/pkg/log/log.go
src/pkg/math/const.go
src/pkg/mime/type.go
src/pkg/net/net.go
src/pkg/net/textproto/textproto.go
src/pkg/netchan/export.go
src/pkg/os/file.go
src/pkg/os/inotify/inotify_linux.go
src/pkg/path/filepath/path.go
src/pkg/path/path.go
src/pkg/reflect/type.go
src/pkg/rpc/server.go
src/pkg/runtime/debug/stack.go
src/pkg/runtime/extern.go
src/pkg/scanner/scanner.go
src/pkg/sort/sort.go
src/pkg/strconv/atof.go
src/pkg/strings/strings.go
src/pkg/sync/mutex.go
src/pkg/syscall/syscall.go
src/pkg/syslog/syslog.go
src/pkg/tabwriter/tabwriter.go
src/pkg/template/template.go
src/pkg/testing/iotest/reader.go
src/pkg/testing/quick/quick.go
src/pkg/testing/script/script.go
src/pkg/testing/testing.go
src/pkg/time/time.go
src/pkg/unicode/letter.go
src/pkg/unsafe/unsafe.go
src/pkg/utf8/utf8.go
src/pkg/websocket/websocket.go

index 27bfd1bf52c0d12ceb7a90b18d472fe6af5f829d..a7e6b7bdff13c9bc3fea7ef9768427ebbdeb0cbc 100644 (file)
@@ -159,7 +159,7 @@ should set up the detailed documentation that follows.
 
 <pre>
 /*
-    The regexp package implements a simple library for
+    Package regexp implements a simple library for
     regular expressions.
 
     The syntax of the regular expressions accepted is:
@@ -186,7 +186,7 @@ If the package is simple, the package comment can be brief.
 </p>
 
 <pre>
-// The path package implements utility routines for
+// Package path implements utility routines for
 // manipulating slash-separated filename paths.
 </pre>
 
index 5b781ff3d7d944243bd20bbfed1bf06d7d745184..52885876589cd0ca6275a8c9c11979046af2d82b 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The tar package implements access to tar archives.
+// Package tar implements access to tar archives.
 // It aims to cover most of the variations, including those produced
 // by GNU and BSD tars.
 //
index 0391d6441f84dcbc56e01ba2fa44410fd820bbcd..17464c5d8e4129d65dc4e7a6ac01d66012d9c49e 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-The zip package provides support for reading ZIP archives.
+Package zip provides support for reading ZIP archives.
 
 See: http://www.pkware.com/documents/casestudies/APPNOTE.TXT
 
index 8c99bd7a0fb7a90d1f98302cfaaaa20c2123944c..c433edb870ec86b8a3bb9c95d59a75bb4ab27371 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The asn1 package implements parsing of DER-encoded ASN.1 data structures,
+// Package asn1 implements parsing of DER-encoded ASN.1 data structures,
 // as defined in ITU-T Rec X.690.
 //
 // See also ``A Layman's Guide to a Subset of ASN.1, BER, and DER,''
index a04d3b1d9c1e4cc21552d72228fac0246a98fe76..4848d427b39d48d474d3fb1a3f2a320a99d62954 100755 (executable)
@@ -2,11 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This file contains operations on unsigned multi-precision integers.
-// These are the building blocks for the operations on signed integers
-// and rationals.
-
-// This package implements multi-precision arithmetic (big numbers).
+// Package big implements multi-precision arithmetic (big numbers).
 // The following numeric types are supported:
 //
 //     - Int   signed integers
 //
 package big
 
+// This file contains operations on unsigned multi-precision integers.
+// These are the building blocks for the operations on signed integers
+// and rationals.
+
 import "rand"
 
 // An unsigned integer x of the form
index 32a25afae9bc4f8693fa72816092cc8a6879bce5..eaae8bb42c35bd8a75e4dd618073b9fa9b91b825 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements buffered I/O.  It wraps an io.Reader or io.Writer
+// Package bufio implements buffered I/O.  It wraps an io.Reader or io.Writer
 // object, creating another object (Reader or Writer) that also implements
 // the interface but provides buffering and some help for textual I/O.
 package bufio
index c12a135738328e7853197caec22b5dd75a8e3ec3..0f9ac98637144427658f07035fb6a32381bdd753 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The bytes package implements functions for the manipulation of byte slices.
-// Analogous to the facilities of the strings package.
+// Package bytes implements functions for the manipulation of byte slices.
+// It is analogous to the facilities of the strings package.
 package bytes
 
 import (
index 725dc4e98218f413734b0edfce88fe7819b7c86d..f3199cad561e21c08a7c5ad84752f3dbcd66e168 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The cmath package provides basic constants
-// and mathematical functions for complex numbers.
+// Package cmath provides basic constants and mathematical functions for
+// complex numbers.
 package cmath
 
 import "math"
index 787ea2533ccdfbd48898bc91ab95f6e224d3ce18..320b80d06994e80e2af5640a471781be7f49be7c 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The flate package implements the DEFLATE compressed data
-// format, described in RFC 1951.  The gzip and zlib packages
-// implement access to DEFLATE-based file formats.
+// Package flate implements the DEFLATE compressed data format, described in
+// RFC 1951.  The gzip and zlib packages implement access to DEFLATE-based file
+// formats.
 package flate
 
 import (
index 3c0b3c5e5fc294748b6374ca0ce1d92b0e5960a3..b0ddc81d2529ada6fbdbcdc27954066fc1c576fa 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The gzip package implements reading and writing of
-// gzip format compressed files, as specified in RFC 1952.
+// Package gzip implements reading and writing of gzip format compressed files,
+// as specified in RFC 1952.
 package gzip
 
 import (
index 8a540cbe6a11c686cc036cfd05bf759ae1349d98..d418bc8561b3702f7523aa8b5c54929db98f243c 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The lzw package implements the Lempel-Ziv-Welch compressed data format,
+// Package lzw implements the Lempel-Ziv-Welch compressed data format,
 // described in T. A. Welch, ``A Technique for High-Performance Data
 // Compression'', Computer, 17(6) (June 1984), pp 8-19.
 //
index b191c27330616b114b39f6c2ed4c92bf60ea5c6d..8a3ef1580aaeb74b5afb305bb5e5ef8c21b7358a 100644 (file)
@@ -3,8 +3,8 @@
 // license that can be found in the LICENSE file.
 
 /*
-The zlib package implements reading and writing of zlib
-format compressed data, as specified in RFC 1950.
+Package zlib implements reading and writing of zlib format compressed data,
+as specified in RFC 1950.
 
 The implementation provides filters that uncompress during reading
 and compress during writing.  For example, to write compressed data
index 4435a57c4e80ac023ea247c38c75d8f9b6a33ef9..f2b8a750a45c16ee18b3fed854f7df4ae1623d33 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package provides heap operations for any type that implements
+// Package heap provides heap operations for any type that implements
 // heap.Interface.
 //
 package heap
index c1ebcddaa7afadaf2b2f5dd98554a9d1de18e2dd..a3fd4b39f322433fa05fc276309aecf558e18440 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The list package implements a doubly linked list.
+// Package list implements a doubly linked list.
 //
 // To iterate over a list (where l is a *List):
 //     for e := l.Front(); e != nil; e = e.Next() {
index 5925164e9db5f6c0e59dc4608bd22f2857ff753f..cc870ce93649ac1b491b7ba3f2d785b03dc601e1 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The ring package implements operations on circular lists.
+// Package ring implements operations on circular lists.
 package ring
 
 // A Ring is an element of a circular list, or ring.
index a2febb6deebf5a80632e81a449983286e5b4ca20..bfb5481fb8904bdb0c251781ab7bfb520c6f72e2 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The vector package implements containers for managing sequences
-// of elements. Vectors grow and shrink dynamically as necessary.
+// Package vector implements containers for managing sequences of elements.
+// Vectors grow and shrink dynamically as necessary.
 package vector
 
 
index 97a5b64ec6425a27bb9df42f61e4bd75c865d2f5..25acd0d1702f2b2c387f4c61bcc6c42534bff432 100644 (file)
@@ -2,12 +2,12 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// AES constants - 8720 bytes of initialized data.
-
-// This package implements AES encryption (formerly Rijndael),
-// as defined in U.S. Federal Information Processing Standards Publication 197.
+// Package aes implements AES encryption (formerly Rijndael), as defined in
+// U.S. Federal Information Processing Standards Publication 197.
 package aes
 
+// This file contains AES constants - 8720 bytes of initialized data.
+
 // http://www.csrc.nist.gov/publications/fips/fips197/fips-197.pdf
 
 // AES is based on the mathematical behavior of binary polynomials
index 947f762d8bc54d1c025242eba07d3117d9e65d9d..f3c5175acfaa358216caa12a572bcbbfb03d0937 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements Bruce Schneier's Blowfish encryption algorithm.
+// Package blowfish implements Bruce Schneier's Blowfish encryption algorithm.
 package blowfish
 
 // The code is a port of Bruce Schneier's C implementation.
index 35f3e64b6433b95edc3ba7e1f4439658a0a9a273..cb62e3132e8d17886f68ed2b7d6cf17bdd717026 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements CAST5, as defined in RFC 2144. CAST5 is a common
+// Package cast5 implements CAST5, as defined in RFC 2144. CAST5 is a common
 // OpenPGP cipher.
 package cast5
 
index 50516b23a13cfe27701aa9476cf6d48b07f0b011..1ffaa8c2c330795e237e7b6172614f8f77c2d3ee 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The cipher package implements standard block cipher modes
-// that can be wrapped around low-level block cipher implementations.
+// Package cipher implements standard block cipher modes that can be wrapped
+// around low-level block cipher implementations.
 // See http://csrc.nist.gov/groups/ST/toolkit/BCM/current_modes.html
 // and NIST Special Publication 800-38A.
 package cipher
index be6b34adf28442c9f3dbe1a9c8e838df7f44dc3e..53672a4da3c9efc40931c5f721cc000eaa8a7186 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The crypto package collects common cryptographic constants.
+// Package crypto collects common cryptographic constants.
 package crypto
 
 import (
index 2296e9607776affef2b91d98583d24f9a72c83f1..335c9645dc6ab56c1bb59b46df838191d9d05315 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The elliptic package implements several standard elliptic curves over prime
-// fields
+// Package elliptic implements several standard elliptic curves over prime
+// fields.
 package elliptic
 
 // This package operates, internally, on Jacobian coordinates. For a given
index 298fb2c06943f3b502bedcd7f3c4fa3ed890a052..04ec86e9ab115787f2b90e4f9c40d1db7a3a34a5 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The hmac package implements the Keyed-Hash Message Authentication Code (HMAC)
-// as defined in U.S. Federal Information Processing Standards Publication 198.
+// Package hmac implements the Keyed-Hash Message Authentication Code (HMAC) as
+// defined in U.S. Federal Information Processing Standards Publication 198.
 // An HMAC is a cryptographic hash that uses a key to sign a message.
 // The receiver verifies the hash by recomputing it using the same key.
 package hmac
index ee46544a920b32ee67864c9ed7508016769126ea..848d9552df55a0ed1620f9be978e716ec9263b75 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the MD4 hash algorithm as defined in RFC 1320.
+// Package md4 implements the MD4 hash algorithm as defined in RFC 1320.
 package md4
 
 import (
index 8f93fc4b354eecf94a467bad45352dfe47462969..378faa6ec71a247ca53ea0dc0dad478a1449e62e 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the MD5 hash algorithm as defined in RFC 1321.
+// Package md5 implements the MD5 hash algorithm as defined in RFC 1321.
 package md5
 
 import (
index f42d8088884c30f0127f4c71468611af7f5b9e18..acd75b8b06ef1609fdfab68c02612c5611a83ed2 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package parses OCSP responses as specified in RFC 2560. OCSP responses
+// Package ocsp parses OCSP responses as specified in RFC 2560. OCSP responses
 // are signed messages attesting to the validity of a certificate for a small
 // period of time. This is used to manage revocation for X.509 certificates.
 package ocsp
index d695a8c3325fafea1333421a4e4cda2b230c41f5..8da612c500777233d8717ce47afaea45257af492 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements OpenPGP ASCII Armor, see RFC 4880. OpenPGP Armor is
+// Package armor implements OpenPGP ASCII Armor, see RFC 4880. OpenPGP Armor is
 // very similar to PEM except that it has an additional CRC checksum.
 package armor
 
index 053d159672627c0bf64b8344befcf0c7b14b4f9d..3759ce16122672bebe0500b184c62d483e1a0777 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package contains common error types for the OpenPGP packages.
+// Package error contains common error types for the OpenPGP packages.
 package error
 
 import (
index 57ff3afbfc702609c48950f55a51d1b20b7b9861..c0ec44dd8ec53867128a621240ba8e45465c4d86 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements parsing and serialisation of OpenPGP packets, as
+// Package packet implements parsing and serialisation of OpenPGP packets, as
 // specified in RFC 4880.
 package packet
 
index ac6998f0d247914676fe64f00191285f63e37dfa..4f84dff82bb95b7eacbf2f096260521386542d49 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This openpgp package implements high level operations on OpenPGP messages.
+// Package openpgp implements high level operations on OpenPGP messages.
 package openpgp
 
 import (
index 873b33dc0d54d99ffd971c647905624890296de8..93b7582fa06a5feb033ee5ca630102c64147ddf3 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the various OpenPGP string-to-key transforms as
+// Package s2k implements the various OpenPGP string-to-key transforms as
 // specified in RFC 4800 section 3.7.1.
 package s2k
 
index 65fd195f3de47c826eb7aa39dd5eef7783b2cb4f..7ee471093b4f485fa6c9bc5dfd58b2eeee4449e6 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements RC4 encryption, as defined in Bruce Schneier's
+// Package rc4 implements RC4 encryption, as defined in Bruce Schneier's
 // Applied Cryptography.
 package rc4
 
index 6e88521c3f6c58c7afee82d390e4c04a868bd90b..5aaca59a3cfc10f86ef6de700cd6ed6d12540fc4 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the RIPEMD-160 hash algorithm.
+// Package ripemd160 implements the RIPEMD-160 hash algorithm.
 package ripemd160
 
 // RIPEMD-160 is designed by by Hans Dobbertin, Antoon Bosselaers, and Bart
index b3b212c2066ca9bb0f4e4cb884f947a646047a8b..c5bdf0e8cdda0acf48a8914f74b7517f80f2e909 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements RSA encryption as specified in PKCS#1.
+// Package rsa implements RSA encryption as specified in PKCS#1.
 package rsa
 
 // TODO(agl): Add support for PSS padding.
index e6aa096e2a6b9c07ae1f7e8687b4d18efa1b4a12..788d1ff5552d77e003c0d27c52955d23d8c6b5d6 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the SHA1 hash algorithm as defined in RFC 3174.
+// Package sha1 implements the SHA1 hash algorithm as defined in RFC 3174.
 package sha1
 
 import (
index 69b356b4e5132297fad466df20b5bb159a1f06bb..a2c058d180e8e665fad431c70e872ad57f8a1083 100644 (file)
@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the SHA224 and SHA256 hash algorithms as defined in FIPS 180-2.
+// Package sha256 implements the SHA224 and SHA256 hash algorithms as defined
+// in FIPS 180-2.
 package sha256
 
 import (
index 7e9f330e594a4c08c212d2d47ea28ebd09d9c802..78f5fe26f80762f82877156dc9d5a65dfd5b2ae5 100644 (file)
@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the SHA384 and SHA512 hash algorithms as defined in FIPS 180-2.
+// Package sha512 implements the SHA384 and SHA512 hash algorithms as defined
+// in FIPS 180-2.
 package sha512
 
 import (
index a3d70b9c96e3e4d2237ea7738a72558e51741e4c..57dbe9db555af592883d27e31b5f0bd46c8e7375 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements functions that are often useful in cryptographic
+// Package subtle implements functions that are often useful in cryptographic
 // code but require careful thought to use correctly.
 package subtle
 
index 7de44bbd244df80afe6451ef0d8754e22e60f4d7..7d0bb9f34b86555d2974b0a3ea7a309ba6cc2f45 100644 (file)
@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package partially implements the TLS 1.1 protocol, as specified in RFC 4346.
+// Package tls partially implements the TLS 1.1 protocol, as specified in RFC
+// 4346.
 package tls
 
 import (
index 62253e79788132fdfe40dfbb6ebcad974cb6d8a7..9303f03ffd8bc68b1633bb1e4517c5c09594eac4 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements Bruce Schneier's Twofish encryption algorithm.
+// Package twofish implements Bruce Schneier's Twofish encryption algorithm.
 package twofish
 
 // Twofish is defined in http://www.schneier.com/paper-twofish-paper.pdf [TWOFISH]
index 39cb3443aed115b41749c9cf5d8657fef8738a85..f9e6eb6b3f4e766e5cdfa60ab920ab3e8729c38b 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package parses X.509-encoded keys and certificates.
+// Package x509 parses X.509-encoded keys and certificates.
 package x509
 
 import (
index b0fa2a1844d849d3278e3e5fb5772254f9371eb0..f2a5da0035c59aa2c0a0517cf6270909f85cc722 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements XTEA encryption, as defined in Needham and
-// Wheeler's 1997 technical report, "Tea extensions."
+// Package xtea implements XTEA encryption, as defined in Needham and Wheeler's
+// 1997 technical report, "Tea extensions."
 package xtea
 
 // For details, see http://www.cix.co.uk/~klockstone/xtea.pdf
index cb009e0e09e96d7cdd47671ed4638fe876349f58..d9525f78835bceef818936e8c10ef30469a1c401 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package provides access to DWARF debugging information
-// loaded from executable files, as defined in the DWARF 2.0 Standard
-// at http://dwarfstd.org/doc/dwarf-2.0.0.pdf
+// Package dwarf provides access to DWARF debugging information loaded from
+// executable files, as defined in the DWARF 2.0 Standard at
+// http://dwarfstd.org/doc/dwarf-2.0.0.pdf
 package dwarf
 
 import (
index e5aabd582b3c1d2046f91398e555e81031b7ce12..7918c4593bbaa1203b3a90086078301f9dbe9962 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A library for EBNF grammars. The input is text ([]byte) satisfying
-// the following grammar (represented itself in EBNF):
+// Package ebnf is a library for EBNF grammars. The input is text ([]byte)
+// satisfying the following grammar (represented itself in EBNF):
 //
 //     Production  = name "=" Expression "." .
 //     Expression  = Alternative { "|" Alternative } .
index 292d917eb4c218fe98b7231e31b23ca8d8c859b7..891de1861077d17f342568144a320ede00dd3e45 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements hexadecimal encoding and decoding.
+// Package hex implements hexadecimal encoding and decoding.
 package hex
 
 import (
index f46ce1c83a05711c4a0eb87d3ed241eaf94f600f..123962b1f917998fda722a48ba32a22bb2860b82 100644 (file)
@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The line package implements a Reader that reads lines delimited by '\n' or ' \r\n'.
+// Package line implements a Reader that reads lines delimited by '\n' or
+// ' \r\n'.
 package line
 
 import (
index 5653aeb77c700388b3766c8d0093bd0931cf1cb7..44e3d0ad0949e9ee98da0216edccad246b6adb88 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the PEM data encoding, which originated in Privacy
+// Package pem implements the PEM data encoding, which originated in Privacy
 // Enhanced Mail. The most common use of PEM encoding today is in TLS keys and
 // certificates. See RFC 1421.
 package pem
index 5398eb8e0ca35b4f908725f9e479f65bdb307dca..043f847283e6d1c57299987c7c3e8584240ff4a5 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The exec package runs external commands. It wraps os.StartProcess
-// to make it easier to remap stdin and stdout, connect I/O with pipes,
-// and do other adjustments.
+// Package exec runs external commands. It wraps os.StartProcess to make it
+// easier to remap stdin and stdout, connect I/O with pipes, and do other
+// adjustments.
 package exec
 
 // BUG(r): This package should be made even easier to use or merged into os.
index 6d816fc2d3d71bd35cfcfee744e9b19f13e26199..fec45e4afe9bff6b8f684857a3354f63fb31a4f3 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-/*     The datafmt package implements syntax-directed, type-driven formatting
+/*     Package datafmt implements syntax-directed, type-driven formatting
        of arbitrary data structures. Formatting a data structure consists of
        two phases: first, a parser reads a format specification and builds a
        "compiled" format. Then, the format can be applied repeatedly to
index 53294af15c0d95b3bf7cf367d6e1db4868d2b42d..81c67267db64ebc820fed0588b9db603bd5e19f1 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements an X11 backend for the exp/draw package.
+// Package x11 implements an X11 backend for the exp/draw package.
 //
 // The X protocol specification is at ftp://ftp.x.org/pub/X11R7.0/doc/PDF/proto.pdf.
 // A summary of the wire format can be found in XCB's xproto.xml.
index 02d18bd7935cf1d55e10ea6a177d546a2fb80dc5..a5f6ac7e5e788aeb0c00180ad3d157593b7429bf 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package is the beginning of an interpreter for Go.
+// Package eval is the beginning of an interpreter for Go.
 // It can run simple Go programs but does not implement
 // interface values or packages.
 package eval
index 813d3a875a6c85ed93d1dfee82ebff38e13f2e7a..a8db523ea18e9cdb17f5559b19e5f8366511e819 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Ogle is the beginning of a debugger for Go.
+// Package ogle is the beginning of a debugger for Go.
 package ogle
 
 import (
index 7736aea0a02acc50fe10a2584b46bbcb5c030e09..7123d4b0f77c5c4d599f0d787693c295b0797f72 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The expvar package provides a standardized interface to public variables,
-// such as operation counters in servers. It exposes these variables via
-// HTTP at /debug/vars in JSON format.
+// Package expvar provides a standardized interface to public variables, such
+// as operation counters in servers. It exposes these variables via HTTP at
+// /debug/vars in JSON format.
 //
 // Operations to set or modify these public variables are atomic.
 //
index 19a3104553f379e5b1b244dac12514d557886142..9ed20e06b5a9df77ac050d79a2f7e0db7f136850 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-       The flag package implements command-line flag parsing.
+       Package flag implements command-line flag parsing.
 
        Usage:
 
index ed3e2cdd9be51400fbd84b00fc676f1ca936987a..2fc1a60323dfdc0b9bb9e8683f63cfff04ad057c 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The AST package declares the types used to represent
-// syntax trees for Go packages.
+// Package ast declares the types used to represent syntax trees for Go
+// packages.
 //
 package ast
 
index e7a8d3f63bbda80b1827f3bcf7c73c299bf8c614..29d205d391c82c076f4b45dd82099133b923599e 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The doc package extracts source code documentation from a Go AST.
+// Package doc extracts source code documentation from a Go AST.
 package doc
 
 import (
index 84a0da6ae7bddd6693e93bcb6464d2bd38d966c5..5c57e41d130fa5fe7f39f5a5e593db23870adea2 100644 (file)
@@ -2,10 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A parser for Go source files. Input may be provided in a variety of
-// forms (see the various Parse* functions); the output is an abstract
-// syntax tree (AST) representing the Go source. The parser is invoked
-// through one of the Parse* functions.
+// Package parser implements a parser for Go source files. Input may be
+// provided in a variety of forms (see the various Parse* functions); the
+// output is an abstract syntax tree (AST) representing the Go source. The
+// parser is invoked through one of the Parse* functions.
 //
 package parser
 
index 697a83fa8665cf0dc24a386f9e798f9d4fd89cb3..01ebf783c416525c5f0a537024669ffabe405a2e 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The printer package implements printing of AST nodes.
+// Package printer implements printing of AST nodes.
 package printer
 
 import (
index 2f949ad25689660b7369a3d6e252809286f9340e..07b7454c87d3450fdfcd2cacbf08d27553a9216b 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A scanner for Go source text. Takes a []byte as source which can
-// then be tokenized through repeated calls to the Scan function.
-// Typical use:
+// Package scanner implements a scanner for Go source text. Takes a []byte as
+// source which can then be tokenized through repeated calls to the Scan
+// function. Typical use:
 //
 //     var s Scanner
 //     fset := token.NewFileSet()  // position information is relative to fset
index a5f21df168e7db04d324e1649517ca4388bee4b8..c2ec80ae14007deece386c6676be347c34d12b98 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package defines constants representing the lexical
-// tokens of the Go programming language and basic operations
-// on tokens (printing, predicates).
+// Package token defines constants representing the lexical tokens of the Go
+// programming language and basic operations on tokens (printing, predicates).
 //
 package token
 
index 72384e121712372880da1ec85801b670f5578fba..2ee645d989b751ef4131b4608c91a03a01546bf1 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 // PACKAGE UNDER CONSTRUCTION. ANY AND ALL PARTS MAY CHANGE.
-// The types package declares the types used to represent Go types.
+// Package types declares the types used to represent Go types.
 //
 package types
 
index 613974a000fbdc9c6109b33c3de96084bac8af87..189086f525cc020a6770805fdfc8a6130fbb37cc 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-The gob package manages streams of gobs - binary values exchanged between an
+Package gob manages streams of gobs - binary values exchanged between an
 Encoder (transmitter) and a Decoder (receiver).  A typical use is transporting
 arguments and results of remote procedure calls (RPCs) such as those provided by
 package "rpc".
index cd0c2599ac0bef0bd3a21b4d2a74798132c39ec7..f13a9379338a3112b11825139746da2e4d0994be 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the Adler-32 checksum.
+// Package adler32 implements the Adler-32 checksum.
 // Defined in RFC 1950:
 //     Adler-32 is composed of two sums accumulated per byte: s1 is
 //     the sum of all bytes, s2 is the sum of all s1 values. Both sums
index 2ab0c54919d877ba45faf19fc0991ea7d9e23278..88a449971684b35139c3a59a289a92ef7ce49f71 100644 (file)
@@ -2,8 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the 32-bit cyclic redundancy check, or CRC-32, checksum.
-// See http://en.wikipedia.org/wiki/Cyclic_redundancy_check for information.
+// Package crc32 implements the 32-bit cyclic redundancy check, or CRC-32,
+// checksum. See http://en.wikipedia.org/wiki/Cyclic_redundancy_check for
+// information.
 package crc32
 
 import (
index 8443865645e8b705e08b65c980489ad09e061c53..ae37e781cd0ad8972b334ab4d8b8ab79d79f71de 100644 (file)
@@ -2,8 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements the 64-bit cyclic redundancy check, or CRC-64, checksum.
-// See http://en.wikipedia.org/wiki/Cyclic_redundancy_check for information.
+// Package crc64 implements the 64-bit cyclic redundancy check, or CRC-64,
+// checksum. See http://en.wikipedia.org/wiki/Cyclic_redundancy_check for
+// information.
 package crc64
 
 import (
index 66ab5a635bf0f792b64f042c6e3c2648e89ffe62..9a1c6a0f2db97989ab3e891e76876f95f545053d 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The fnv package implements FNV-1 and FNV-1a,
-// non-cryptographic hash functions created by
-// Glenn Fowler, Landon Curt Noll, and Phong Vo.
+// Package fnv implements FNV-1 and FNV-1a, non-cryptographic hash functions
+// created by Glenn Fowler, Landon Curt Noll, and Phong Vo.
 // See http://isthe.com/chongo/tech/comp/fnv/.
 package fnv
 
index 56ac259db13a9be5df00fa66f033950d05ac87f0..3536c0b6a64a89dbb279276ded71ef47525bab90 100644 (file)
@@ -2,6 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package hash provides interfaces for hash functions.
 package hash
 
 import "io"
index 4f5dee72da32a135a16bb5ba631f4b4f42473d3a..55135c3d05fb198324a9884f6ca8463a66438c79 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-The html package implements an HTML5-compliant tokenizer and parser.
+Package html implements an HTML5-compliant tokenizer and parser.
 
 Tokenization is done by creating a Tokenizer for an io.Reader r. It is the
 caller's responsibility to ensure that r provides UTF-8 encoded HTML.
index 0dd19a617cc4c58334215daa97658c2ada0fbe62..f2fedefcfd1cc5e4ef3c9c3fe78f0bd1ac09d0be 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The httptest package provides utilities for HTTP testing.
+// Package httptest provides utilities for HTTP testing.
 package httptest
 
 import (
index 5eebf8333b273350f29e8b9e48a619a3207db030..633c91e8d20ccd6188a89c87a96fad5c108f8947 100644 (file)
@@ -4,9 +4,8 @@
 
 // HTTP Request reading and parsing.
 
-// The http package implements parsing of HTTP requests, replies,
-// and URLs and provides an extensible HTTP server and a basic
-// HTTP client.
+// Package http implements parsing of HTTP requests, replies, and URLs and
+// provides an extensible HTTP server and a basic HTTP client.
 package http
 
 import (
index c0e96e1f7b17046be67ee6b40d1bc6b95a0f590f..5f398a30476f19fc7d38094cd7e8d8e7b1f3cf86 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The image package implements a basic 2-D image library.
+// Package image implements a basic 2-D image library.
 package image
 
 // A Config consists of an image's color model and dimensions.
index eee4eac2e1527a17cf256a548f208f7931282ac5..b30a951c1c905fd458bb77e90305c1700abde742 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The png package implements a PNG image decoder and encoder.
+// Package png implements a PNG image decoder and encoder.
 //
 // The PNG specification is at http://www.libpng.org/pub/png/spec/1.2/PNG-Contents.html
 package png
index b2e033b8215ea41034777e39fe66accd020dde42..cda45996df04007856732aebba6b6611cf227498 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The ycbcr package provides images from the Y'CbCr color model.
+// Package ycbcr provides images from the Y'CbCr color model.
 //
 // JPEG, VP8, the MPEG family and other codecs use this color model. Such
 // codecs often use the terms YUV and Y'CbCr interchangeably, but strictly
index d8c6fc91b489ae67ca55f704cff918022265e1f3..079b7d8ed0bcfef8d1bec107147c72d1d4afc605 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The suffixarray package implements substring search in logarithmic time
-// using an in-memory suffix array.
+// Package suffixarray implements substring search in logarithmic time using
+// an in-memory suffix array.
 //
 // Example use:
 //
index d3707eb1dba6f97d60c33065e006c81b5620cdce..0bc73d67dd93dbc7e2e58bb779e0283a6d1b63ba 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package provides basic interfaces to I/O primitives.
+// Package io provides basic interfaces to I/O primitives.
 // Its primary job is to wrap existing implementations of such primitives,
 // such as those in package os, into shared public interfaces that
 // abstract the functionality, plus some other related primitives.
index 57d797e851cf89b227733d8af637a83e3f795195..ac481928b44934221f549f807f29063cec20525f 100644 (file)
@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Utility functions.
-
+// Package ioutil implements some I/O utility functions.
 package ioutil
 
 import (
index dfa3c59da5c6dcf6eee980eb1d3935b2983fde9d..281334e37cbb921cf1e090a7ddad63cfc2965493 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The json package implements encoding and decoding of JSON objects as
-// defined in RFC 4627.
+// Package json implements encoding and decoding of JSON objects as defined in
+// RFC 4627.
 package json
 
 import (
index 33140ee08afa08e358a2d100645bd1b330c6e69e..00bce6a17dc23e6351be5df644862d7e1e330e29 100644 (file)
@@ -2,9 +2,9 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Simple logging package. It defines a type, Logger, with methods
-// for formatting output. It also has a predefined 'standard' Logger
-// accessible through helper functions Print[f|ln], Fatal[f|ln], and
+// Package log implements a simple logging package. It defines a type, Logger,
+// with methods for formatting output. It also has a predefined 'standard'
+// Logger accessible through helper functions Print[f|ln], Fatal[f|ln], and
 // Panic[f|ln], which are easier to use than creating a Logger manually.
 // That logger writes to standard error and prints the date and time
 // of each logged message.
index b53527a4f397c90374c1d5982f6acb5af9cb90b6..a108d3e294d9a0a8f54759ca2fad4ffd591a64a1 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The math package provides basic constants and mathematical functions.
+// Package math provides basic constants and mathematical functions.
 package math
 
 // Mathematical constants.
index 6fe0ed5fd5e0584cf4c819bf83a69cf7a032fbca..8c43b81b0c56c70ea8ce918c862fe982575cde27 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The mime package implements parts of the MIME spec.
+// Package mime implements parts of the MIME spec.
 package mime
 
 import (
index 04a898a9aac04824421672eea0e76ef1054190f5..51db107395401b9a77bfb7aaad9e4bff33a03661 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The net package provides a portable interface to Unix
-// networks sockets, including TCP/IP, UDP, domain name
-// resolution, and Unix domain sockets.
+// Package net provides a portable interface to Unix networks sockets,
+// including TCP/IP, UDP, domain name resolution, and Unix domain sockets.
 package net
 
 // TODO(rsc):
index fbfad9d61ce4519ef28e66c1045f0c946c792bbe..9f19b5495d12e060a908e12cddecaae59f2233a6 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The textproto package implements generic support for
-// text-based request/response protocols in the style of
-// HTTP, NNTP, and SMTP.
+// Package textproto implements generic support for text-based request/response
+// protocols in the style of HTTP, NNTP, and SMTP.
 //
 // The package provides:
 //
index dacee4f183356f44eaefd69b11a21c10a3c8974d..55dbc4fccbb38847d8297534c0685d2f57b09d1a 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-       The netchan package implements type-safe networked channels:
+       Package netchan implements type-safe networked channels:
        it allows the two ends of a channel to appear on different
        computers connected by a network.  It does this by transporting
        data sent to a channel on one machine so it can be recovered
index 3aad8023453358517fdede659574941e625af93a..643b225ce7f608e225e213fbfe6a03502be0ea40 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The os package provides a platform-independent interface to operating
-// system functionality.  The design is Unix-like.
+// Package os provides a platform-independent interface to operating system
+// functionality.  The design is Unix-like.
 package os
 
 import (
index 8b5c30e0dc8432c05361f47d82312a7d309749ac..7c7b7698feb82ba9adc2a3a7acec3d5a6a90a39a 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-This package implements a wrapper for the Linux inotify system.
+Package inotify implements a wrapper for the Linux inotify system.
 
 Example:
     watcher, err := inotify.NewWatcher()
index de673a7257725cf0d3e266af206f393794bad87d..541a233066a159a2036825c6c4676361b15cfccf 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The filepath package implements utility routines for manipulating
-// filename paths in a way compatible with the target operating
-// system-defined file paths.
+// Package filepath implements utility routines for manipulating filename paths
+// in a way compatible with the target operating system-defined file paths.
 package filepath
 
 import (
index 658eec0938706dfd3b6bab90bb77f30a71d89cc6..235384667c678c2c1630368ee30640cd630926c8 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The path package implements utility routines for manipulating
-// slash-separated filename paths.
+// Package path implements utility routines for manipulating slash-separated
+// filename paths.
 package path
 
 import (
index 5e3051cab51c8feb7e22835a32253f4c09abff59..a4008105604799ef9204083bbb1519f290702dcd 100644 (file)
@@ -2,10 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The reflect package implements run-time reflection, allowing a program to
-// manipulate objects with arbitrary types.  The typical use is to take a
-// value with static type interface{} and extract its dynamic type
-// information by calling Typeof, which returns a Type.
+// Package reflect implements run-time reflection, allowing a program to
+// manipulate objects with arbitrary types.  The typical use is to take a value
+// with static type interface{} and extract its dynamic type information by
+// calling Typeof, which returns a Type.
 //
 // A call to NewValue returns a Value representing the run-time data.
 // Zero takes a Type and returns a Value representing a zero value
index d46bc4343e066f4abf070f025f5c52e61b763f9e..d67978a48e511563680504f7a106139c5f608c9f 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-       The rpc package provides access to the exported methods of an object across a
+       Package rpc provides access to the exported methods of an object across a
        network or other I/O connection.  A server registers an object, making it visible
        as a service with the name of the type of the object.  After registration, exported
        methods of the object will be accessible remotely.  A server may register multiple
index e7d56ac233d012e2d70a177fd7142672d73bfe60..e5fae632b13cde25f14fba25459d4511fd58553d 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The debug package contains facilities for programs to debug themselves
-// while they are running.
+// Package debug contains facilities for programs to debug themselves while
+// they are running.
 package debug
 
 import (
index c6e664abbbb90354efe0d8b8a842edfe2b67fdb0..9da3423c61867eabd8668a6de1d45614ab45b5da 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-       The runtime package contains operations that interact with Go's runtime system,
+       Package runtime contains operations that interact with Go's runtime system,
        such as functions to control goroutines. It also includes the low-level type information
        used by the reflect package; see reflect's documentation for the programmable
        interface to the run-time type system.
index ec22664773a6ac4570769cacd68f274ebe35506a..e79d392f70c97e2682e8675da5119b68e111092b 100644 (file)
@@ -2,10 +2,11 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A scanner and tokenizer for UTF-8-encoded text.  Takes an io.Reader
-// providing the source, which then can be tokenized through repeated calls
-// to the Scan function.  For compatibility with existing tools, the NUL
-// character is not allowed (implementation restriction).
+// Package scanner provides a scanner and tokenizer for UTF-8-encoded text.
+// It takes an io.Reader providing the source, which then can be tokenized
+// through repeated calls to the Scan function.  For compatibility with
+// existing tools, the NUL character is not allowed (implementation
+// restriction).
 //
 // By default, a Scanner skips white space and Go comments and recognizes all
 // literals as defined by the Go language specification.  It may be
index c7945d21b612fffe851c19a6b7b9b755c2cae14c..30b1819af2dd199ec361421751c08b60008ef034 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The sort package provides primitives for sorting arrays
-// and user-defined collections.
+// Package sort provides primitives for sorting arrays and user-defined
+// collections.
 package sort
 
 // A type, typically a collection, that satisfies sort.Interface can be
index 72f162c51344c5d4ce0a2413ad16f89ce2b4c978..a91e8bfa4aaeb0d3ce81ac3bade6c861ff1c2918 100644 (file)
@@ -2,16 +2,16 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
+// Package strconv implements conversions to and from string representations
+// of basic data types.
+package strconv
+
 // decimal to binary floating point conversion.
 // Algorithm:
 //   1) Store input in multiprecision decimal.
 //   2) Multiply/divide decimal by powers of two until in range [0.5, 1)
 //   3) Multiply by 2^precision and round to get mantissa.
 
-// The strconv package implements conversions to and from
-// string representations of basic data types.
-package strconv
-
 import (
        "math"
        "os"
index 93c7c46473882c6cf115d9d6c41a5488d7da2a83..bfd057180d7034ff673fbb1cd310272316b753c1 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// A package of simple functions to manipulate strings.
+// Package strings implements simple functions to manipulate strings.
 package strings
 
 import (
index da565d38defe7df07592e2d3031b2be178406605..13f03cad39452eb4cab48f694ec77114ad1ae006 100644 (file)
@@ -2,11 +2,10 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The sync package provides basic synchronization primitives
-// such as mutual exclusion locks.  Other than the Once and
-// WaitGroup types, most are intended for use by low-level
-// library routines.  Higher-level synchronization is better
-// done via channels and communication.
+// Package sync provides basic synchronization primitives such as mutual
+// exclusion locks.  Other than the Once and WaitGroup types, most are intended
+// for use by low-level library routines.  Higher-level synchronization is
+// better done via channels and communication.
 package sync
 
 import (
index 2a9ffd4afbe9de654cbbe4f6616319ef0fbdf1fa..157abaa8b41714a506572f684551e165e48b21f9 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package contains an interface to the low-level operating system
+// Package syscall contains an interface to the low-level operating system
 // primitives.  The details vary depending on the underlying system.
 // Its primary use is inside other packages that provide a more portable
 // interface to the system, such as "os", "time" and "net".  Use those
index 4ada113f1d7692260769749d9783ad3a636e6d24..69333721276c4f5a5b8a284de336ad6c906f33a8 100644 (file)
@@ -2,9 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The syslog package provides a simple interface to
-// the system log service. It can send messages to the
-// syslog daemon using UNIX domain sockets, UDP, or
+// Package syslog provides a simple interface to the system log service. It
+// can send messages to the syslog daemon using UNIX domain sockets, UDP, or
 // TCP connections.
 package syslog
 
index 848703e8ca0ce622c1f168eb8ac388eb2b54bf10..d91a07db242da9e390f368e87a4f9954846dfab7 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The tabwriter package implements a write filter (tabwriter.Writer)
-// that translates tabbed columns in input into properly aligned text.
+// Package tabwriter implements a write filter (tabwriter.Writer) that
+// translates tabbed columns in input into properly aligned text.
 //
 // The package is using the Elastic Tabstops algorithm described at
 // http://nickgravgaard.com/elastictabstops/index.html.
index 28872dbee449a525836136d647e5c2532097b9b1..733c7e16f53cbbb59c80c26e68e502693385a229 100644 (file)
@@ -3,8 +3,8 @@
 // license that can be found in the LICENSE file.
 
 /*
-       Data-driven templates for generating textual output such as
-       HTML.
+       Package template implements data-driven templates for generating textual
+       output such as HTML.
 
        Templates are executed by applying them to a data structure.
        Annotations in the template refer to elements of the data
index 647520a09fc3bd16546ccef39ee6032027812efc..e4003d7445019cbfd65cf613261c1d8e8a88ab6e 100644 (file)
@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The iotest package implements Readers and Writers
-// useful only for testing.
+// Package iotest implements Readers and Writers useful only for testing.
 package iotest
 
 import (
index 94450da988d3af68900440054b4ac6fb67b1a4c6..40f33f01545fef9b3277ae41f6eeebd7097dc89a 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package implements utility functions to help with black box testing.
+// Package quick implements utility functions to help with black box testing.
 package quick
 
 import (
index b1801849709c4adf868610cf4a913ca06aad9f57..109abe2b41d61f15c7f742ff73ce2a786f869b44 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package aids in the testing of code that uses channels.
+// Package script aids in the testing of code that uses channels.
 package script
 
 import (
index 1e65528ef9689dee95d41b652f9006ed69fd6eb6..8781b207defcfdfccedbb3c86120af5fd542ce99 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The testing package provides support for automated testing of Go packages.
+// Package testing provides support for automated testing of Go packages.
 // It is intended to be used in concert with the ``gotest'' utility, which automates
 // execution of any function of the form
 //     func TestXxx(*testing.T)
index 40338f7752a48c61c2db906be9018e660bb2ec4e..a0480786aa5e7b80da5f26c2077e7785110725b8 100644 (file)
@@ -2,8 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The time package provides functionality for measuring and
-// displaying time.
+// Package time provides functionality for measuring and displaying time.
 package time
 
 // Days of the week.
index 9380624fd9e556f989d82d6c265626206b5c8e20..382c6eb3f47cbf7eb770471ce75377e97b2aea28 100644 (file)
@@ -2,7 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// This package provides data and functions to test some properties of Unicode code points.
+// Package unicode provides data and functions to test some properties of
+// Unicode code points.
 package unicode
 
 const (
index 3cd4cff6e9902b75229bbf1398fb22bc730a50aa..8507bed52589db6026df3d1a7878a9af5468467d 100644 (file)
@@ -3,7 +3,7 @@
 // license that can be found in the LICENSE file.
 
 /*
-       The unsafe package contains operations that step around the type safety of Go programs.
+       Package unsafe contains operations that step around the type safety of Go programs.
 */
 package unsafe
 
index 455499e4d950762dc763be4864ba76b4c6c916fa..f542358d6dcbed06a98b3ac0ee59ad24ae786ce6 100644 (file)
@@ -2,8 +2,8 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// Functions and constants to support text encoded in UTF-8.
-// This package calls a Unicode character a rune for brevity.
+// Package utf8 implements functions and constants to support text encoded in
+// UTF-8. This package calls a Unicode character a rune for brevity.
 package utf8
 
 import "unicode" // only needed for a couple of constants
index d5996abe1a5836461b9503efbece00a31fbab28b..eaad22eb33603a20b82a4942dd07d16701fe4c53 100644 (file)
@@ -2,7 +2,7 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The websocket package implements a client and server for the Web Socket protocol.
+// Package websocket implements a client and server for the Web Socket protocol.
 // The protocol is defined at http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol
 package websocket