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.
27 lines
737 B
Go
27 lines
737 B
Go
// Copyright (c) 2020-2022 The Decred developers
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
/*
|
|
Package progresslog provides periodic logging for block processing.
|
|
|
|
Tests are included to ensure proper functionality.
|
|
|
|
# Feature Overview
|
|
|
|
The following are the primary features provided:
|
|
|
|
- Maintains cumulative totals about blocks between each logging interval
|
|
- Logs all cumulative data every 10 seconds
|
|
- Immediately logs any outstanding data when requested by the caller
|
|
|
|
The cumulative totals include:
|
|
|
|
- Total number of blocks
|
|
- Total number of transactions
|
|
- Total number of votes
|
|
- Total number of tickets
|
|
- Total number of revocations
|
|
*/
|
|
package progresslog
|