Browse Source

docs: any path can be absolute or relative (#4035)

Fixes #4026
pull/4035/merge
Anton Kaliaev 5 years ago
committed by GitHub
parent
commit
e024805354
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 3 deletions
  1. +5
    -0
      config/toml.go
  2. +1
    -1
      docs/spec/reactors/mempool/config.md
  3. +8
    -2
      docs/tendermint-core/configuration.md

+ 5
- 0
config/toml.go View File

@ -67,6 +67,11 @@ func WriteConfigFile(configFilePath string, config *Config) {
const defaultConfigTemplate = `# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
# NOTE: Any path below can be absolute (e.g. "/var/myawesomeapp/data") or
# relative to the home directory (e.g. "data"). The home directory is
# "$HOME/.tendermint" by default, but could be changed via $TMHOME env variable
# or --home cmd flag.
##### main base config options #####
# TCP or UNIX socket address of the ABCI application,


+ 1
- 1
docs/spec/reactors/mempool/config.md View File

@ -51,4 +51,4 @@ If the directory passed in is an absolute path, the wal file is
created there. If the directory is a relative path, the path is
appended to home directory of the tendermint process to
generate an absolute path to the wal directory
(default `$HOME/.tendermint` or set via `TM_HOME` or `--home``)
(default `$HOME/.tendermint` or set via `TM_HOME` or `--home`)

+ 8
- 2
docs/tendermint-core/configuration.md View File

@ -2,8 +2,9 @@
Tendermint Core can be configured via a TOML file in
`$TMHOME/config/config.toml`. Some of these parameters can be overridden by
command-line flags. For most users, the options in the `##### main base configuration options #####` are intended to be modified while
config options further below are intended for advance power users.
command-line flags. For most users, the options in the `##### main base
configuration options #####` are intended to be modified while config options
further below are intended for advance power users.
## Options
@ -16,6 +17,11 @@ like the file below, however, double check by inspecting the
# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml
# NOTE: Any path below can be absolute (e.g. "/var/myawesomeapp/data") or
# relative to the home directory (e.g. "data"). The home directory is
# "$HOME/.tendermint" by default, but could be changed via $TMHOME env variable
# or --home cmd flag.
##### main base config options #####
# TCP or UNIX socket address of the ABCI application,


Loading…
Cancel
Save