Permalink
Browse files

Extracted package documentation to its own file.

  • Loading branch information...
1 parent 27ee8c3 commit 86da961a420784d3e6cafd10df5e4d2ad98f042a @phf committed Dec 13, 2009
Showing with 42 additions and 37 deletions.
  1. +1 −1 Makefile
  2. +0 −36 core.go
  3. +41 −0 doc.go
View
@@ -5,7 +5,7 @@ include $(GOROOT)/src/Make.$(GOARCH)
TARG=db/sqlite3
CGOFILES=low.go
-GOFILES=core.go error.go util.go connection.go statement.go result.go classic.go set.go
+GOFILES=core.go error.go util.go connection.go statement.go result.go classic.go set.go doc.go
CGO_LDFLAGS=-lsqlite3
CLEANFILES+=example test.db
View
36 core.go
@@ -2,42 +2,6 @@
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
-// SQLite database driver for Go.
-//
-// Please see http://www.sqlite.org/c3ref/intro.html for all
-// the missing details. Sorry, our documentation is focused
-// on driver details, not on SQLite in general.
-//
-// Restrictions on Types:
-//
-// For now, we treat *all* values as strings. This is less of
-// an issue for SQLite since it's typed dynamically anyway.
-// Accepting/returning appropriate Go types is a high priority
-// goal though.
-//
-// Binding Query Parameters:
-//
-// SQL queries can contain "?" parameter slots that are bound
-// to values in Execute(). SQLite has more variations that we
-// don't support for now: they would make the API more complex
-// for very little gain. Parameter slots are matched to values
-// in order of appearance.
-//
-// Concurrency:
-//
-// We still need to address concurrency issues in detail, for
-// now we simply force SQLite into "serialized" threading mode
-// (see http://www.sqlite.org/threadsafe.html for details).
-//
-//
-// Low-Level API:
-//
-// The file low.go contains the low-level API for SQLite. The
-// API is not exposed, and you should only have to worry about
-// it if you're hunting for bugs in the database driver. Note
-// that the technical reason for the low-level API is that cgo
-// can't process multiple files at once (a factoid that really
-// doesn't have any bearing whatsoever on applications).
package sqlite3
import (
View
41 doc.go
@@ -0,0 +1,41 @@
+// Copyright 2009 Peter H. Froehlich. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+
+// SQLite database driver for Go.
+//
+// Please see http://www.sqlite.org/c3ref/intro.html for all
+// the missing details. Sorry, our documentation is focused
+// on driver details, not on SQLite in general.
+//
+// Restrictions on Types:
+//
+// For now, we treat *all* values as strings. This is less of
+// an issue for SQLite since it's typed dynamically anyway.
+// Accepting/returning appropriate Go types is a high priority
+// goal though.
+//
+// Binding Query Parameters:
+//
+// SQL queries can contain "?" parameter slots that are bound
+// to values in Execute(). SQLite has more variations that we
+// don't support for now: they would make the API more complex
+// for very little gain. Parameter slots are matched to values
+// in order of appearance.
+//
+// Concurrency:
+//
+// We still need to address concurrency issues in detail, for
+// now we simply force SQLite into "serialized" threading mode
+// (see http://www.sqlite.org/threadsafe.html for details).
+//
+//
+// Low-Level API:
+//
+// The file low.go contains the low-level API for SQLite. The
+// API is not exposed, and you should only have to worry about
+// it if you're hunting for bugs in the database driver. Note
+// that the technical reason for the low-level API is that cgo
+// can't process multiple files at once (a factoid that really
+// doesn't have any bearing whatsoever on applications).
+package sqlite3

0 comments on commit 86da961

Please sign in to comment.