Repository: trafficserver Updated Branches: refs/heads/master 9be03cfbf -> a17db36fb
TS-4077: docs: build warnings cleanup Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/a17db36f Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/a17db36f Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/a17db36f Branch: refs/heads/master Commit: a17db36fbf2338a0553badba6d16555d186d4ffc Parents: 9be03cf Author: Jon Sime <[email protected]> Authored: Tue Feb 16 19:23:48 2016 +0000 Committer: Jon Sime <[email protected]> Committed: Tue Feb 16 19:23:48 2016 +0000 ---------------------------------------------------------------------- doc/admin-guide/installation/index.en.rst | 8 ++++---- doc/admin-guide/monitoring/error-messages.en.rst | 2 +- .../monitoring/logging/understanding.en.rst | 2 +- doc/admin-guide/plugins/ts_lua.en.rst | 15 +++++++-------- 4 files changed, 13 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a17db36f/doc/admin-guide/installation/index.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin-guide/installation/index.en.rst b/doc/admin-guide/installation/index.en.rst index d272bd5..2c933f9 100644 --- a/doc/admin-guide/installation/index.en.rst +++ b/doc/admin-guide/installation/index.en.rst @@ -250,10 +250,10 @@ For a list of :program:`traffic_ctl` commands, enter:: bin/traffic_ctl -Please note that :program:`traffic_ctl`, while a fine tool for an -administrator, is a poor choice for automation, especially that of -monitoring. See our chapter on :ref:`monitoring-traffic` -for how to do that more efficiently and effectively. +Please note that :program:`traffic_ctl`, while a fine tool for administrators, +is a poor choice for automation, especially that of monitoring. See our chapter +on :ref:`monitoring <admin-monitoring>` for how to do that more efficiently and +effectively. .. _stop-traffic-server: http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a17db36f/doc/admin-guide/monitoring/error-messages.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin-guide/monitoring/error-messages.en.rst b/doc/admin-guide/monitoring/error-messages.en.rst index dd7afb6..1f36c71 100644 --- a/doc/admin-guide/monitoring/error-messages.en.rst +++ b/doc/admin-guide/monitoring/error-messages.en.rst @@ -141,7 +141,7 @@ Traffic Server returns detailed error messages to client browsers when there are problems with the HTTP transactions requested by the browser. These Traffic Server response messages correspond to standard HTTP response codes, but provide more information. A list of the more frequently encountered HTTP response codes -is provided in :ref:`standard-http-response-messages`. +is provided in :ref:`appendix-http-status-codes`. The error messages can be customized. The actual response is generated from a template. These templates are stored in files which means the errors responses can be customized by modifying these http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a17db36f/doc/admin-guide/monitoring/logging/understanding.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin-guide/monitoring/logging/understanding.en.rst b/doc/admin-guide/monitoring/logging/understanding.en.rst index f9a56f6..c10f67f 100644 --- a/doc/admin-guide/monitoring/logging/understanding.en.rst +++ b/doc/admin-guide/monitoring/logging/understanding.en.rst @@ -54,7 +54,7 @@ every error it detects in log files. |TS| keeps three types of log files: logged, the hostname of the Traffic Server that reported the error, and a description of the error or warning. - Refer to :ref:`traffic-server-error-messages` for a list of the + Refer to :ref:`admin-monitoring-errors` for a list of the messages logged by Traffic Server. By default, |TS| creates both error and event log files and http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a17db36f/doc/admin-guide/plugins/ts_lua.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin-guide/plugins/ts_lua.en.rst b/doc/admin-guide/plugins/ts_lua.en.rst index ee8e206..8c1f9c8 100644 --- a/doc/admin-guide/plugins/ts_lua.en.rst +++ b/doc/admin-guide/plugins/ts_lua.en.rst @@ -2970,7 +2970,7 @@ ts.stat_find **context:** global -**description:** This function can be used to find a statistics record given the name. A statistics record table will +**description:** This function can be used to find a statistics record given the name. A statistics record table will be returned with 4 functions to increment, decrement, get and set the value. That is similar to ts.stat_create() `TOP <#ts-lua-plugin>`_ @@ -2985,12 +2985,13 @@ transaction. This can be wasteful. Also the state cannot be reused for the same alternative will be to use a TXN_START hook to create a lua state first and then add each global hook in the lua script as transaction hook instead. But this will have problem down the road when we need to have multiple plugins to work together in some proper orderings. In the future, we should consider different approach, such as creating and -maintaining the lua state in the ATS core. +maintaining the lua state in the ATS core. `TOP <#ts-lua-plugin>`_ Notes on Unit Testing Lua scripts for ATS Lua Plugin ==================================================== + Follow the steps below to use busted framework to run some unit tests on sample scripts and modules * Build and install lua 5.1.5 using the source code from here - http://www.lua.org/ftp/lua-5.1.tar.gz @@ -3003,18 +3004,16 @@ Follow the steps below to use busted framework to run some unit tests on sample * "cd trafficserver/plugins/experimental/ts_lua/ci" -* Run "busted -c module_test.lua; luacov". It will produce "luacov.report.out" containing the code coverage for -* "module.lua" +* Run "busted -c module_test.lua; luacov". It will produce "luacov.report.out" containing the code coverage for "module.lua" -* Run "busted -c script_test.lua; luacov". It will produce "luacov.report.out" containing the code coverage for -* "script.lua" +* Run "busted -c script_test.lua; luacov". It will produce "luacov.report.out" containing the code coverage for "script.lua" Reference for further information * Busted - http://olivinelabs.com/busted/ -* Specifications for asserts/mocks/stubs/etc inside busted framework - -https://github.com/Olivine-Labs/luassert/tree/master/spec +* Specifications for asserts/mocks/stubs/etc inside busted framework: + https://github.com/Olivine-Labs/luassert/tree/master/spec * luacov - https://luarocks.org/modules/hisham/luacov
