You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/08/16 22:00:28 UTC
[1/2] git commit: doc: add configuration variables to the index
Updated Branches:
refs/heads/master dfba93de1 -> eb4e26384
doc: add configuration variables to the index
Add configuration variables to the Sphinx index. I don't know whether
I'm doing this right, but I beat Sphinx. In your face, Sphinx!
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/a0d96c58
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/a0d96c58
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/a0d96c58
Branch: refs/heads/master
Commit: a0d96c5877dfe4066cb410eafb1c873da6b325ac
Parents: dfba93d
Author: James Peach <jp...@apache.org>
Authored: Fri Aug 16 12:57:12 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Aug 16 12:57:12 2013 -0700
----------------------------------------------------------------------
doc/ext/traffic-server.py | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a0d96c58/doc/ext/traffic-server.py
----------------------------------------------------------------------
diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
index f87feea..5911d9c 100644
--- a/doc/ext/traffic-server.py
+++ b/doc/ext/traffic-server.py
@@ -66,7 +66,7 @@ class TSConfVar(std.Target):
anchor = nodes.target('', '', names=[cv_name])
# Second (optional) arg is 'msgNode' - no idea what I should pass for that
# or if it even matters, although I now think it should not be used.
- self.state.document.note_explicit_target(anchor);
+ self.state.document.note_explicit_target(anchor)
env.domaindata['ts']['cv'][cv_name] = env.docname
fl = nodes.field_list()
@@ -85,7 +85,18 @@ class TSConfVar(std.Target):
nn = nodes.compound();
self.state.nested_parse(self.content, self.content_offset, nn)
- return [ anchor, title, fl, nn ]
+ # Create an index node so that Sphinx adds this config variable to the
+ # index. nodes.make_id() specifies the link anchor name that is
+ # implicitly generated by the anchor node above.
+ indexnode = sphinx.addnodes.index(entries=[])
+ indexnode['ids'].append(cv_name)
+ indexnode['entries'].append(
+ ('single', _('%s') % cv_name, nodes.make_id(cv_name), '')
+ )
+
+ return [
+ indexnode, anchor, title, fl, nn
+ ]
class TSConfVarRef(XRefRole):
def process_link(self, env, ref_node, explicit_title_p, title, target):
[2/2] git commit: doc: fix proxy.confg.log.collation_host format
Posted by jp...@apache.org.
doc: fix proxy.confg.log.collation_host format
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/eb4e2638
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/eb4e2638
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/eb4e2638
Branch: refs/heads/master
Commit: eb4e263849bc057ad94722e653a78a5ae24f8c77
Parents: a0d96c5
Author: James Peach <jp...@apache.org>
Authored: Fri Aug 16 13:00:23 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Fri Aug 16 13:00:23 2013 -0700
----------------------------------------------------------------------
doc/reference/configuration/records.config.en.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/eb4e2638/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index e2a2b8f..8959312 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -1362,7 +1362,7 @@ server, refer to `logs_xml.config <logs_xml.config>`_.
.. note:: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.
-.. ts:cv:: proxy.confg.log.collation_host STRING NULL
+.. ts:cv:: CONFIG proxy.confg.log.collation_host STRING NULL
The hostname of the log collation server.