From e0248053546bcc29df459defa416aa5387c46637 Mon Sep 17 00:00:00 2001 From: Anton Kaliaev Date: Wed, 2 Oct 2019 12:23:32 -0700 Subject: [PATCH] docs: any path can be absolute or relative (#4035) Fixes #4026 --- config/toml.go | 5 +++++ docs/spec/reactors/mempool/config.md | 2 +- docs/tendermint-core/configuration.md | 10 ++++++++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/config/toml.go b/config/toml.go index 268c96ff9..5290ec4e4 100644 --- a/config/toml.go +++ b/config/toml.go @@ -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, diff --git a/docs/spec/reactors/mempool/config.md b/docs/spec/reactors/mempool/config.md index 4fb756fa4..77deded42 100644 --- a/docs/spec/reactors/mempool/config.md +++ b/docs/spec/reactors/mempool/config.md @@ -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`) diff --git a/docs/tendermint-core/configuration.md b/docs/tendermint-core/configuration.md index 59a259669..3ad116229 100644 --- a/docs/tendermint-core/configuration.md +++ b/docs/tendermint-core/configuration.md @@ -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,