mirror of
https://github.com/FlipsideCrypto/dcrd.git
synced 2026-02-06 10:56:47 +00:00
sampleconfig: Add package README and doc.go.
This adds a readme and doc.go for the sampleconfig package so it is consistent with all of the other packages. While here, it also changes the exported value to a constant and removes the unused sampleConfigFilename constant.
This commit is contained in:
parent
d18bca456e
commit
f0a01ced0a
@ -55,7 +55,6 @@ const (
|
||||
defaultMaxOrphanTransactions = 1000
|
||||
defaultMaxOrphanTxSize = 5000
|
||||
defaultSigCacheMaxSize = 100000
|
||||
sampleConfigFilename = "sample-dcrd.conf"
|
||||
defaultTxIndex = false
|
||||
defaultNoExistsAddrIndex = false
|
||||
)
|
||||
|
||||
23
sampleconfig/README.md
Normal file
23
sampleconfig/README.md
Normal file
@ -0,0 +1,23 @@
|
||||
sampleconfig
|
||||
============
|
||||
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/sampleconfig)
|
||||
|
||||
Package sampleconfig provides a single constant that contains the contents of
|
||||
the sample configuration file for dcrd. This is provided for tools that perform
|
||||
automatic configuration and would like to ensure the generated configuration
|
||||
file not only includes the specifically configured values, but also provides
|
||||
samples of other configuration options.
|
||||
|
||||
## Installation and Updating
|
||||
|
||||
```bash
|
||||
$ go get -u github.com/decred/dcrd/sampleconfig
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
Package sampleconfig is licensed under the [copyfree](http://copyfree.org) ISC
|
||||
License.
|
||||
12
sampleconfig/doc.go
Normal file
12
sampleconfig/doc.go
Normal file
@ -0,0 +1,12 @@
|
||||
// Copyright (c) 2017 The Decred developers
|
||||
// Use of this source code is governed by an ISC
|
||||
// license that can be found in the LICENSE file.
|
||||
|
||||
/*
|
||||
Package sampleconfig provides a single constant that contains the contents of
|
||||
the sample configuration file for dcrd. This is provided for tools that perform
|
||||
automatic configuration and would like to ensure the generated configuration
|
||||
file not only includes the specifically configured values, but also provides
|
||||
samples of other configuration options.
|
||||
*/
|
||||
package sampleconfig
|
||||
@ -5,7 +5,7 @@
|
||||
package sampleconfig
|
||||
|
||||
// FileContents is a string containing the commented example config for dcrd.
|
||||
var FileContents = `[Application Options]
|
||||
const FileContents = `[Application Options]
|
||||
|
||||
; ------------------------------------------------------------------------------
|
||||
; Data settings
|
||||
|
||||
Loading…
Reference in New Issue
Block a user