You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-cvs@tcl.apache.org by mx...@apache.org on 2015/01/08 16:02:43 UTC
svn commit: r1650305 - in /tcl/rivet/branches/2.2/doc: rivet.xml
xml/commands.xml xml/directives.xml xml/intro.xml
Author: mxmanghi
Date: Thu Jan 8 15:02:42 2015
New Revision: 1650305
URL: http://svn.apache.org/r1650305
Log:
more adjustments to the manual
Modified:
tcl/rivet/branches/2.2/doc/rivet.xml
tcl/rivet/branches/2.2/doc/xml/commands.xml
tcl/rivet/branches/2.2/doc/xml/directives.xml
tcl/rivet/branches/2.2/doc/xml/intro.xml
Modified: tcl/rivet/branches/2.2/doc/rivet.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/2.2/doc/rivet.xml?rev=1650305&r1=1650304&r2=1650305&view=diff
==============================================================================
--- tcl/rivet/branches/2.2/doc/rivet.xml (original)
+++ tcl/rivet/branches/2.2/doc/rivet.xml Thu Jan 8 15:02:42 2015
@@ -4,29 +4,29 @@
"http://www.oasis-open.org/committees/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY hello.rvt SYSTEM "examples-sgml/hello.rvt" >
<!ENTITY hello1.rvt SYSTEM "examples-sgml/hello1.rvt" >
- <!ENTITY color-table.tcl SYSTEM "examples-sgml/color-table.tcl" >
- <!ENTITY vars.html SYSTEM "examples-sgml/vars.html" >
+ <!ENTITY color-table.tcl SYSTEM "examples-sgml/color-table.tcl" >
+ <!ENTITY vars.html SYSTEM "examples-sgml/vars.html" >
<!ENTITY vars.rvt SYSTEM "examples-sgml/vars.rvt" >
<!ENTITY upload.html SYSTEM "examples-sgml/upload.html" >
<!ENTITY upload.rvt SYSTEM "examples-sgml/upload.rvt" >
<!ENTITY download.tcl SYSTEM "examples-sgml/download.tcl" >
- <!ENTITY rivet_web_service.tcl SYSTEM "examples-sgml/rivet_web_service.tcl" >
- <!ENTITY intro.xml SYSTEM "xml/intro.xml" >
- <!ENTITY install.xml SYSTEM "xml/install.xml" >
- <!ENTITY directives.xml SYSTEM "xml/directives.xml" >
- <!ENTITY commands.xml SYSTEM "xml/commands.xml" >
- <!ENTITY examples.xml SYSTEM "xml/examples.xml" >
- <!ENTITY packages.xml SYSTEM "xml/packages.xml" >
- <!ENTITY dio.xml SYSTEM "xml/dio.xml" >
- <!ENTITY diodisplay.xml SYSTEM "xml/diodisplay.xml" >
- <!ENTITY session.xml SYSTEM "xml/session.xml" >
- <!ENTITY form.xml SYSTEM "xml/form.xml" >
- <!ENTITY calendar.xml SYSTEM "xml/calendar.xml" >
- <!ENTITY help.xml SYSTEM "xml/help.xml" >
- <!ENTITY internals.xml SYSTEM "xml/internals.xml" >
- <!ENTITY upgrade.xml SYSTEM "xml/upgrade.xml" >
- <!ENTITY request.xml SYSTEM "xml/request.xml" >
- <!ENTITY entities.xml SYSTEM "xml/entities.xml" >
+ <!ENTITY rivet_web_service.tcl SYSTEM "examples-sgml/rivet_web_service.tcl" >
+ <!ENTITY intro.xml SYSTEM "xml/intro.xml" >
+ <!ENTITY install.xml SYSTEM "xml/install.xml" >
+ <!ENTITY directives.xml SYSTEM "xml/directives.xml" >
+ <!ENTITY commands.xml SYSTEM "xml/commands.xml" >
+ <!ENTITY examples.xml SYSTEM "xml/examples.xml" >
+ <!ENTITY packages.xml SYSTEM "xml/packages.xml" >
+ <!ENTITY dio.xml SYSTEM "xml/dio.xml" >
+ <!ENTITY diodisplay.xml SYSTEM "xml/diodisplay.xml" >
+ <!ENTITY session.xml SYSTEM "xml/session.xml" >
+ <!ENTITY form.xml SYSTEM "xml/form.xml" >
+ <!ENTITY calendar.xml SYSTEM "xml/calendar.xml" >
+ <!ENTITY help.xml SYSTEM "xml/help.xml" >
+ <!ENTITY internals.xml SYSTEM "xml/internals.xml" >
+ <!ENTITY upgrade.xml SYSTEM "xml/upgrade.xml" >
+ <!ENTITY request.xml SYSTEM "xml/request.xml" >
+ <!ENTITY entities.xml SYSTEM "xml/entities.xml" >
]>
<!--
@@ -64,6 +64,7 @@
<year>2012</year>
<year>2013</year>
<year>2014</year>
+ <year>2015</year>
<holder>Apache Software Foundation</holder>
</copyright>
<author>
Modified: tcl/rivet/branches/2.2/doc/xml/commands.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/2.2/doc/xml/commands.xml?rev=1650305&r1=1650304&r2=1650305&view=diff
==============================================================================
--- tcl/rivet/branches/2.2/doc/xml/commands.xml (original)
+++ tcl/rivet/branches/2.2/doc/xml/commands.xml Thu Jan 8 15:02:42 2015
@@ -1379,7 +1379,7 @@ bab</programlisting>
code a dictionary with 2 keys:
<itemizedlist>
<listitem><command>error_code</command>: string literal 'redirect'</listitem>
- <listitem><command>location</command>: the URL the browser is about to be redirected</listitem>
+ <listitem><command>location</command>: the URL the browser will be redirected to</listitem>
</itemizedlist>
</para>
<para>
@@ -1388,18 +1388,18 @@ bab</programlisting>
attempts to discard the output the script might have already placed in the
stdout channel buffer. Therefore the command can fail if
<itemizedlist>
- <listitem>Somewhere a <command>flush stdout</command> was called
- causing the HTTP headers to be sent, thus preventing any possibility to
+ <listitem>A <command>flush stdout</command> was called before <command>::rivet::redirect</command>
+ thus causing the HTTP headers to be sent and preventing any possibility to
manipulate them</listitem>
- <listitem>The channel buffer had been filled already, causing Tcl to
+ <listitem>The channel buffer was filled causing Tcl to
flush the channel</listitem>
</itemizedlist>
The <command>stdout</command> channel, like any Tcl channels, can be manipulated
- and its internal buffer streched if needed.
+ and if needed its internal buffer streched.
</para>
-
</refsect1>
</refentry>
+
<refentry id="read_file">
<refnamediv>
<refname>read_file</refname>
Modified: tcl/rivet/branches/2.2/doc/xml/directives.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/2.2/doc/xml/directives.xml?rev=1650305&r1=1650304&r2=1650305&view=diff
==============================================================================
--- tcl/rivet/branches/2.2/doc/xml/directives.xml (original)
+++ tcl/rivet/branches/2.2/doc/xml/directives.xml Thu Jan 8 15:02:42 2015
@@ -371,7 +371,7 @@
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry>
<term>
<cmdsynopsis>
<arg choice="plain">SeparateChannels</arg>
@@ -385,9 +385,9 @@
<para>
Internally mod_rivet creates a new Tcl channel (Rivet channel) which is configured
as <command>stdout</command> and registered to each existing interpreter.
- There is no need for multiple channels in a single thread as each thread can
+ There is no need of multiple channels in a single thread as each thread can
serve only one request at a time. But if you are deploying mod_rivet in a
- complex environment running many unrelated application, developed by
+ complex environment running unrelated applications developed by
different teams, it could be the case to have <command>SeparateVirtualInterps</command>
set. If you want to enhance the environment separation you may also
set <command>SeparateChannels</command> to force mod_rivet to create
@@ -395,38 +395,37 @@
code to change the Rivet channel parameters without affecting other
applications (even though changing the Tcl channel parameters is a rare
necessity). Setting this options increases the system overheads as each
- Rivet channel needs to allocate their private control structures and internal
- buffers
+ Rivet channel needs to allocate its own control structures and internal
+ buffers.
</para>
<note>
- Notice that this is not needed if you have control over your application
- </note>
- <note>
- This option is, by nature, only available at the
- global level has effect only if <command>SeparateVirtualInterps</command>
- is set
+ This option is implemented in order to have fine grain control over mod_rivet. In
+ nearly all practical cases you won't need to change Rivet Channel (stdout) settings
+ for different applications by calling <command>fconfigure stdout ....</command>.
+ This option is, by nature, only available at the global level and has effect only if
+ also <command>SeparateVirtualInterps</command> is set
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>
- <cmdsynopsis>
- <arg choice="plain">HonorHeaderOnlyRequests</arg>
- <group choice="req">
- <arg>yes</arg>
- <arg>no</arg>
- </group>
- </cmdsynopsis>
+ <cmdsynopsis>
+ <arg choice="plain">HonorHeaderOnlyRequests</arg>
+ <group choice="req">
+ <arg>yes</arg>
+ <arg>no</arg>
+ </group>
+ </cmdsynopsis>
</term>
<listitem>
- <para>
- If a HEAD requests is issued by the client Rivet detects
- this case and sends back to the client a standard header
- response. If the real header has to be examined (e.g.
- for debugging) you can turn this options on.
- </para>
- <para>This option is, by nature, only available at the global level</para>
+ <para>
+ If a HEAD requests is issued by the client Rivet detects
+ this case and sends back to the client a standard header
+ response. If the real header has to be examined (e.g.
+ for debugging) you can turn this options on.
+ </para>
+ <para>This option is, by nature, only available at the global level</para>
</listitem>
</varlistentry>
</variablelist>
Modified: tcl/rivet/branches/2.2/doc/xml/intro.xml
URL: http://svn.apache.org/viewvc/tcl/rivet/branches/2.2/doc/xml/intro.xml?rev=1650305&r1=1650304&r2=1650305&view=diff
==============================================================================
--- tcl/rivet/branches/2.2/doc/xml/intro.xml (original)
+++ tcl/rivet/branches/2.2/doc/xml/intro.xml Thu Jan 8 15:02:42 2015
@@ -17,7 +17,6 @@
giving you ideas on how to best take advantage of Rivet's
architecture to create different styles of web site.
</para>
-
<para>
This documentation is focused on the current version of Rivet, but
still a work in progress, and, like everything
@@ -30,11 +29,14 @@
<simplesect>
<title>Acknowledgements</title>
<para>
- Rivet's development took advantage from contributions from
+ Rivet 2.2 development took advantage from contributions from
several users who provided whole new componenents, bug fixes and
- enhancements.
+ enhancements.
</para>
<itemizedlist>
+ <listitem><emphasis>Damon Courtney</emphasis> (Apache Tcl Team member,
+ he originally wrote mod_rivet) contributed with the new
+ <command>::rivet::redirect</command> command.</listitem>
<listitem>
<emphasis>Harald Oehlmann</emphasis> (now member of the Apache Tcl Team)
who wrote package RivetEntitites, command ::rivet::http_accept and filed
@@ -43,6 +45,6 @@
<listitem><emphasis>Cyril Shtumf</emphasis> filed several important bugfixes</listitem>
<listitem><emphasis>Jeff Lawson</emphasis> who patched Rivet parser to add the
shorthand syntax for string output and filed several bug reports</listitem>
- </itemizedlist>
- </simplesect>
+ </itemizedlist>
+ </simplesect>
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: site-cvs-unsubscribe@tcl.apache.org
For additional commands, e-mail: site-cvs-help@tcl.apache.org