Permalink
Browse files

docs(conf/cli) improve help messages and config comments

  • Loading branch information...
1 parent d77235d commit 013e394cc0786d3f5df946294d42179fb0016aec @thibaultcha thibaultcha committed Aug 12, 2016
Showing with 8 additions and 6 deletions.
  1. +4 −2 kong.conf.default
  2. +2 −2 kong/cmd/restart.lua
  3. +1 −1 kong/cmd/start.lua
  4. +1 −1 kong/cmd/version.lua
View
@@ -204,7 +204,7 @@
# However, in some cases (specifically NAT
# traversal), there may be a routable address
# that cannot be bound to. This flag enables
- # gossiping a different address to support
+ # advertising a different address to support
# this.
#cluster_encrypt_key = # base64-encoded 16-bytes key to encrypt
@@ -220,7 +220,7 @@
# attempting to connect to it.
# Recommended to be at least `60`.
-#cluster_profile = wan # The timing profile for infracluster pings
+#cluster_profile = wan # The timing profile for inter-cluster pings
# and timeouts. If a `lan` or `local` profile
# is used over the Internet, a high rate of
# failures is risked as the timing contraints
@@ -272,6 +272,8 @@
# will be loaded from scratch. Useful for
# adopting an edit-and-refresh approach while
# developing a plugin.
+ # Turning this directive off has a severe
+ # impact on performance.
#lua_package_path = # Sets the Lua module search path (LUA_PATH).
# Useful when developing or using custom
@@ -16,8 +16,8 @@ end
local lapp = [[
Usage: kong restart [OPTIONS]
-Restart a Kong node (and start other configured services
-if necessary) in given prefix directory.
+Restart a Kong node (and other configured services like dnsmasq and Serf)
+in the given prefix directory.
This command is equivalent to doing both 'kong stop' and
'kong start'.
View
@@ -25,7 +25,7 @@ end
local lapp = [[
Usage: kong start [OPTIONS]
-Start Kong (Nginx and other configured services) in configured
+Start Kong (Nginx and other configured services) in the configured
prefix directory.
Options:
@@ -1,7 +1,7 @@
local meta = require "kong.meta"
local lapp = [[
-Usage: kong version
+Usage: kong version [OPTIONS]
Print Kong's version. With the -a option, will print
the version of all underlying dependencies.

0 comments on commit 013e394

Please sign in to comment.