ad02d8f300
This modifies the entire repository to use the new formatting of doc comments in the upcoming Go 1.19 release. The primary motivating factors for this are: - Builds check that files are formatted per gofmt and that will no longer be true as of Go 1.19 without these changes - Separating all the updates into a single commit ensures these documentation only formatting changes do not clutter up diffs that actually change code For the most part, the changes are just the automated changes suggested by the Go 1.19 version of gofmt, but there are also a few cases where the comments were reworded a bit to play nicely with the new formatting requirements. For example, the new version of gofmt reformats and collapses nested lists where as the existing version does not. Thus, instances of nested lists have been changed to either eliminate them or use mixed markers which produce expect results.
31 lines
960 B
Go
31 lines
960 B
Go
// Copyright (c) 2015-2016 The btcsuite developers
|
|
// Copyright (c) 2016 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
/*
|
|
Package ffldb implements a driver for the database package that uses leveldb
|
|
for the backing metadata and flat files for block storage.
|
|
|
|
This driver is the recommended driver for use with dcrd. It makes use leveldb
|
|
for the metadata, flat files for block storage, and checksums in key areas to
|
|
ensure data integrity.
|
|
|
|
# Usage
|
|
|
|
This package is a driver to the database package and provides the database type
|
|
of "ffldb". The parameters the Open and Create functions take are the
|
|
database path as a string and the block network:
|
|
|
|
db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
|
|
db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
|
|
if err != nil {
|
|
// Handle error
|
|
}
|
|
*/
|
|
package ffldb
|