DOC: fix some syntax errors in documents
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/9da35d28 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/9da35d28 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/9da35d28 Branch: refs/heads/5.0.x Commit: 9da35d28da42ba3159011af2e1624dbb640e9996 Parents: 9410b75 Author: Masakazu Kitajo <m4s...@gmail.com> Authored: Sun Dec 22 22:19:27 2013 +0900 Committer: James Peach <jpe...@apache.org> Committed: Sun Dec 22 19:56:20 2013 -0800 ---------------------------------------------------------------------- doc/admin/faqs.en.rst | 2 +- doc/reference/commands/traffic_top.en.rst | 4 ++-- doc/reference/configuration/cache.config.en.rst | 1 + doc/reference/configuration/plugin.config.en.rst | 2 +- doc/reference/plugins/combo_handler.en.rst | 1 + doc/reference/plugins/ts_lua.en.rst | 3 ++- doc/sdk/mutex-guide.en.rst | 2 +- 7 files changed, 9 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/admin/faqs.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst index 79e608f..3236aea 100644 --- a/doc/admin/faqs.en.rst +++ b/doc/admin/faqs.en.rst @@ -29,7 +29,7 @@ FAQs How do you create a raw disk for the cache if all your disks have mounted file systems? --------------------------------------------------------------------------------------- -Create a large file on filesystem (with :manpage`dd(1)`) and mount it as loopback device. +Create a large file on filesystem (with :manpage:`dd(1)`) and mount it as loopback device. This is accomplished with :manpage:`losetup(8)` on Linux, :manpage:`lofiadm(1m)` on Solaris and Illumos, and :manpage:`mdconfig(8)` on FreeBSD. http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/reference/commands/traffic_top.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/commands/traffic_top.en.rst b/doc/reference/commands/traffic_top.en.rst index dec0a05..3c73a1f 100644 --- a/doc/reference/commands/traffic_top.en.rst +++ b/doc/reference/commands/traffic_top.en.rst @@ -15,9 +15,9 @@ specific language governing permissions and limitations under the License. -========== +=========== traffic_top -========== +=========== .. program:: traffic_top http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/reference/configuration/cache.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/cache.config.en.rst b/doc/reference/configuration/cache.config.en.rst index e9a691e..e8c875a 100644 --- a/doc/reference/configuration/cache.config.en.rst +++ b/doc/reference/configuration/cache.config.en.rst @@ -128,6 +128,7 @@ The following list shows possible actions and their allowed values. this content to be stored locally on every cluster node. .. _cache-responses-to-cookies: + ``cache-responses-to-cookies`` Change the style of caching with regard to cookies. This effectively overrides the configuration parameter http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/reference/configuration/plugin.config.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/configuration/plugin.config.en.rst b/doc/reference/configuration/plugin.config.en.rst index f846a2e..ca069b5 100644 --- a/doc/reference/configuration/plugin.config.en.rst +++ b/doc/reference/configuration/plugin.config.en.rst @@ -54,7 +54,7 @@ Server configuration can be changed. If a plugin requires the current value, it must obtain that using the management API. Examples -======= +======== :: http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/reference/plugins/combo_handler.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/combo_handler.en.rst b/doc/reference/plugins/combo_handler.en.rst index a1a70be..eb79002 100644 --- a/doc/reference/plugins/combo_handler.en.rst +++ b/doc/reference/plugins/combo_handler.en.rst @@ -69,6 +69,7 @@ file paths can be extracted and specified separately using a 'p' query parameter. Successive file path parameters are appended to this prefix to create complete file paths. The prefix will remain active until changed or cleared (set to an empty string). For example, the query :: + "/file1&p=/path1/&file2&file3&p=&/file4&p=/dir:path2/&file5&file6" results in these file paths being "reconstructed":: http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/reference/plugins/ts_lua.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/ts_lua.en.rst b/doc/reference/plugins/ts_lua.en.rst index c5015be..e2c896a 100644 --- a/doc/reference/plugins/ts_lua.en.rst +++ b/doc/reference/plugins/ts_lua.en.rst @@ -218,6 +218,7 @@ Synopsis **test_server_intercept.lua** :: + require 'os' function send_data() @@ -561,7 +562,7 @@ ts.client_request.header.HEADER **description**: Set, add to, clear or get the current request's HEADER. -Here is an example: +Here is an example::: function do_remap() local req_host = ts.client_request.header.Host http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9da35d28/doc/sdk/mutex-guide.en.rst ---------------------------------------------------------------------- diff --git a/doc/sdk/mutex-guide.en.rst b/doc/sdk/mutex-guide.en.rst index 5320754..0aa6239 100644 --- a/doc/sdk/mutex-guide.en.rst +++ b/doc/sdk/mutex-guide.en.rst @@ -116,7 +116,7 @@ accessed by other continuations or processes. Here's how: mutexp = TSMutexCreate (); 2. | When you create the continuation, specify this mutex as the - continuation's mutex. + continuation's mutex. | For example: ::
