doc: fix various sphinx syntax errors
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/5e256d25 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/5e256d25 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/5e256d25 Branch: refs/heads/5.0.x Commit: 5e256d253eeb3554cd942f8349032deb4b9c8afa Parents: 8b6ab74 Author: James Peach <jpe...@apache.org> Authored: Sat Dec 7 19:59:15 2013 -0800 Committer: James Peach <jpe...@apache.org> Committed: Tue Dec 10 09:19:35 2013 -0800 ---------------------------------------------------------------------- doc/reference/plugins/balancer.en.rst | 18 ++++++------------ doc/reference/plugins/index.en.rst | 4 ++-- 2 files changed, 8 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/5e256d25/doc/reference/plugins/balancer.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/balancer.en.rst b/doc/reference/plugins/balancer.en.rst index 4fba905..43aa3ed 100644 --- a/doc/reference/plugins/balancer.en.rst +++ b/doc/reference/plugins/balancer.en.rst @@ -24,18 +24,16 @@ Balancer Plugin This is a plugin for Traffic Server, that allows you to configure mapping rules. -To use this plugin, configure a remap.config rule like +To use this plugin, configure a remap.config rule like this:: -:: map http://foo.com http://bar.com @plugin=balancer.so @pparam=rotation:news The "To-Url" in the remap.config rule is generally not used, unless the lookup completely fails (i.e. this is a backup URL for extreme error cases). -This is a list of all available options (set via @pparam): +This is a list of all available options (set via @pparam):: -:: rotation The name of the rotation (e.g. news) [to-host in remap] hash What to hash on, url, path, cookie, ip, header (primary) hash2 Optional, secondary hash, to hash within a multi-host bucket @@ -46,28 +44,24 @@ not specified, we will default to the same name as used in the To URL in the remap rule. The bucket width specifies how many hosts a particular hash bucket -should contain, for example: +should contain, for example:: -:: @pparam=bucketw:2 The hash parameter can be used zero or more times, without it, no hashing is done at all. If you have more than one hash keys, they are -concatenated in the order specified. For example: +concatenated in the order specified. For example:: -:: @pparam=hash:ip @pparam=hash:cookie/B -The "header" hash key takes a required extra value, for example: +The "header" hash key takes a required extra value, for example:: -:: @pparam=hash:header/Host For "cookie" hash keys, you can optionally specify an identifier for which cookie to use (without it, the entire cookie header is used). For -example: +example:: -:: @pparam=hash:cookie/B The secondary hash ("hash2") is used to provide "stickiness" within a http://git-wip-us.apache.org/repos/asf/trafficserver/blob/5e256d25/doc/reference/plugins/index.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/index.en.rst b/doc/reference/plugins/index.en.rst index 875b325..4001acc 100644 --- a/doc/reference/plugins/index.en.rst +++ b/doc/reference/plugins/index.en.rst @@ -51,8 +51,8 @@ Experimental plugins ==================== Plugins that are considered experimental are located in the -```plugins/experimental`` <https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_ -directory in the Apache Traffic Server source tree. Exmperimental plugins can be compiled by passing the +`plugins/experimental <https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_ +directory of the Apache Traffic Server source tree. Exmperimental plugins can be compiled by passing the `--enable-experimental-plugins` option to `configure`:: $ autoconf -i
