You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by di...@apache.org on 2010/03/10 22:54:16 UTC

svn commit: r921586 - in /incubator/trafficserver/site/trunk/docs/v2/sdk: HTTPFunctions.html HTTPSessionFunctions.html HTTPTransactionFunctions.html

Author: dianes
Date: Wed Mar 10 21:54:16 2010
New Revision: 921586

URL: http://svn.apache.org/viewvc?rev=921586&view=rev
Log:
ToC, edits. Big files.

Modified:
    incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPSessionFunctions.html
    incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html?rev=921586&r1=921585&r2=921586&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPFunctions.html Wed Mar 10 21:54:16 2010
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>HTTP Functions</title>
 <!--#include file="top.html" -->
-<div class="navheader">
+</head><div class="navheader">
 <div class="navprev">
 <a accesskey="p" href="INKThreadSelf.html">Prev</a> — INKThreadSelf</div>
 <div class="navnext">Session Functions — <a accesskey="n" href="HTTPSessionFunctions.html">Next</a>
@@ -13,9 +13,63 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
 <a name="HTTPFunctions"></a>HTTP Functions</h2></div></div></div>
+
+<p><b>Table of Contents</b></p>
+<b><ul>
+<li><span class="section"><a href="HTTPFunctions.html#HTTPHookFunctions">Hook Functions</a></span></li>
+<ul><li><a href="HTTPFunctions.html#INKHttpHookAdd">INKHttpHookAdd</a></li></ul>
+
+<li><span class="section"><a href="HTTPSessionFunctions.html">Session Functions</a></span></li>
+<ul>
+<li><a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd">INKHttpSsnHookAdd</a>  </li>  
+<li><a href="HTTPSessionFunctions.html#INKHttpSsnReenable">INKHttpSsnReenable</a>  </li>  
+</ul>
+
+<li><span class="section"><a href="HTTPTransactionFunctions.html">HTTP Transaction Functions</a></span></li>
+
+<ul>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet">INKHttpTxnCacheLookupStatusGet</a></li>
+<ul><li><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet">INKHttpTxnCachedReqGet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet">INKHttpTxnCachedRespGet</a></li></ul>
+
+
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIncomingPortGet">INKHttpTxnClientIncomingPortGet</a></li>
+<ul><li><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIPGet ">INKHttpTxnClientIPGet</a></li>
+</ul>
+
+
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRemotePortGet">INKHttpTxnClientRemotePortGet</a></li>
+<ul> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnClientReqGet">INKHttpTxnClientReqGet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRespGet">INKHttpTxnClientRespGet</a></li>
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnErrorBodySet">INKHttpTxnErrorBodySet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd">INKHttpTxnHookAdd</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet">INKHttpTxnNextHopIPGet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet">INKHttpTxnParentProxyGet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable">INKHttpTxnReenable</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet">INKHttpTxnServerIPGet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet">INKHttpTxnServerReqGet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet">INKHttpTxnServerRespGet</a></li> 
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet">INKHttpTxnSsnGet</a></li> 
+</ul>
+
+
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache">INKHttpTxnTransformedRespCache</a></li>
+<ul><li><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet">INKHttpTxnTransformRespGet</a></li></ul>
+
+<li><a href="HTTPTransactionFunctions.html#INKHttpTxnUntransformedRespCache">INKHttpTxnUntransformedRespCache</a></li>
+
+</ul>
+
+
+</ul></b>
+
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="HTTPHookFunctions"></a>Hook Functions</h3></div></div></div>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpHookAdd"></a>INKHttpHookAdd</h4></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPSessionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPSessionFunctions.html?rev=921586&r1=921585&r2=921586&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPSessionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPSessionFunctions.html Wed Mar 10 21:54:16 2010
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Session Functions</title>
 <!--#include file="top.html" -->
-<div class="navheader">
+</head><div class="navheader">
 <div class="navprev">
 <a accesskey="p" href="HTTPFunctions.html">Prev</a> — HTTP Functions</div>
 <div class="navnext">HTTP Transaction Functions — <a accesskey="n" href="HTTPTransactionFunctions.html">Next</a>
@@ -13,7 +13,13 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="HTTPSessionFunctions"></a>Session Functions</h3></div></div></div>
-<p></p>
+
+
+<ul>
+  <li><a href="HTTPSessionFunctions.html#INKHttpSsnHookAdd"><b>INKHttpSsnHookAdd</b></a>  </li>  
+  <li><b><a href="HTTPSessionFunctions.html#INKHttpSsnReenable">INKHttpSsnReenable</a> </b></li>  
+</ul>
+
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpSsnHookAdd"></a>INKHttpSsnHookAdd</h4></div></div></div>

Modified: incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html?rev=921586&r1=921585&r2=921586&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html (original)
+++ incubator/trafficserver/site/trunk/docs/v2/sdk/HTTPTransactionFunctions.html Wed Mar 10 21:54:16 2010
@@ -3,7 +3,7 @@
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>HTTP Transaction Functions</title>
 <!--#include file="top.html" -->
-<div class="navheader">
+</head><div class="navheader">
 <div class="navprev">
 <a accesskey="p" href="HTTPSessionFunctions.html">Prev</a> — Session Functions</div>
 <div class="navnext">Initiate Connection — <a accesskey="n" href="InitiateConnectionFunctions.html">Next</a>
@@ -13,11 +13,44 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="HTTPTransactionFunctions"></a>HTTP Transaction Functions</h3></div></div></div>
+
+<ul>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCacheLookupStatusGet">INKHttpTxnCacheLookupStatusGet</a></b></li>
+<ul><li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedReqGet">INKHttpTxnCachedReqGet</a></b></li>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnCachedRespGet">INKHttpTxnCachedRespGet</a></b></li>
+</ul>
+
+
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIncomingPortGet">INKHttpTxnClientIncomingPortGet</a></b></li>
+<ul><li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnClientIPGet ">INKHttpTxnClientIPGet</a></b></li>
+</ul>
+
+
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRemotePortGet">INKHttpTxnClientRemotePortGet</a></b></li>
+<ul> <li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnClientReqGet">INKHttpTxnClientReqGet</a></b></li>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnClientRespGet">INKHttpTxnClientRespGet</a></b></li>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnErrorBodySet">INKHttpTxnErrorBodySet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnHookAdd">INKHttpTxnHookAdd</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnNextHopIPGet">INKHttpTxnNextHopIPGet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxyGet">INKHttpTxnParentProxyGet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnParentProxySet">INKHttpTxnParentProxySet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnReenable">INKHttpTxnReenable</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerIPGet">INKHttpTxnServerIPGet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerReqGet">INKHttpTxnServerReqGet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnServerRespGet">INKHttpTxnServerRespGet</a></b></li> 
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnSsnGet">INKHttpTxnSsnGet</a></b></li> 
+</ul>
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformedRespCache">INKHttpTxnTransformedRespCache</a></b></li>
+<ul><li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnTransformRespGet">INKHttpTxnTransformRespGet</a></b></li>
+</ul>
+
+<li><b><a href="HTTPTransactionFunctions.html#INKHttpTxnUntransformedRespCache">INKHttpTxnUntransformedRespCache</a></b></li>
+</ul>
 <div class="section" lang="en">
-<div class="titlepage"><div><div><h4 class="title">
+  <div class="titlepage"><div><div><h4 class="title">
 <a name="INKHttpTxnCacheLookupStatusGet"></a>INKHttpTxnCacheLookupStatusGet</h4></div></div></div>
 <p>Stores the current cache lookup status for the ongoing
-          transaction; also stores the number of cache lookup operations
+          transaction. Also stores the number of cache lookup operations
           already performed.</p>
 <div class="variablelist"><dl>
   <dt><span class="term"><b>Prototype</b></span></dt>
@@ -38,25 +71,25 @@
     variable.</p>
   <p>This function should only be called from
     <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
-  <p>The possible status values returned in
+  <p>Possible status values returned in
     <code class="code"><em class="replaceable"><code>lookup_status </code></em></code>
     are:
   </p><ul>
     <li><code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
-      the cache; it will be fetched from the OS.</li>
+      the cache, so it will be fetched from the origin server.</li>
     <li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
-      present in the cache but stale. A fresher version will be
-      fetched from the OS (IMS request).</li>
+      present in the cache but was stale. A fresher version will be
+      fetched from the origin server (IMS request).</li>
     <li><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
-      present in the cache and is fresh. Document will be served
+      present in the cache and was fresh. Document will be served
       from the cache.</li>
     <li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
-      didn't perform a cache lookup as the request was not cacheable
+      didn't perform a cache lookup because the request was not cacheable
       (this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
   </ul>
   </dd>
 </dl>
-  <p></p>
+
   <dl>
   <dt><span class="term"><b>Returns</b></span></dt>
   <dd>
@@ -84,7 +117,7 @@
 <p><code class="code">INKHttpTxn</code>
                 <code class="code"><em class="replaceable"><code>txnp </code></em></code> is the ongoing
                 transaction.</p>
-<p><code class="code">int *</code><code class="code">lookup_status</code> is set to
+<p><code class="code">int <i>*</i></code><i><code class="code">lookup_status </code></i> is set to
                 the lookup status.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
@@ -96,23 +129,25 @@
 <p>This function should only be called from
                 <code class="code">INK_HTTP_CACHE_LOOKUP_COMPLETE_HOOK</code>.</p>
 <p>The possible status values returned in
-                <code class="code">lookup_status</code> are:</p>
+                <code class="code"><i>lookup_status </i></code> are:</p>
                 <ul>
                 <li>
 <code class="code">INK_CACHE_LOOKUP_MISS</code> - Document was not in
-                the cache; it will be fetched from the OS.</li>
+                the cache; it will be fetched from the origin server.</li>
 <li><code class="code">INK_CACHE_LOOKUP_HIT_STALE</code> - Document was
-                present in the cache but stale. A fresher version will be
-                fetched from the OS (IMS request).</li>
+                present in the cache but was stale. A fresher version will be
+                fetched from the origin server (IMS request).</li>
 <li><code class="code">INK_CACHE_LOOKUP_HIT_FRESH</code> - Document was
-                present in the cache and is fresh. Document will be served
+                present in the cache and was fresh. Document will be served
                 from the cache.</li>
 <li><code class="code">INK_CACHE_LOOKUP_SKIPPED</code> - Traffic Server
                 didn't perform a cache lookup because the request was not cacheable
                 (this can happen when the URL looks dynamic or the request is marked as noncacheable).</li>
-<p></p>
-                </ul>
-</dd>
+ </ul>
+  </dd>
+</dl>
+
+  <dl>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p><code class="code">INK_SUCCESS</code> if the API is called
@@ -154,8 +189,8 @@
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the cached response header does not exist, then
-                <code class="function">INKHttpTxnCachedRespGet</code> returns 0.</p>
-<p>Otherwise, it returns 1.</p>
+                <code class="function">INKHttpTxnCachedRespGet</code> returns <code>0</code>.</p>
+<p>Otherwise, it returns <code>1</code>.</p>
 </dd>
 </dl></div>
 </div>
@@ -172,14 +207,14 @@
 <dd>
 <p>Returns the port on which the HTTP transaction
                 <code class="code"><em class="replaceable"><code>txnp </code></em></code> was received.
-                This is not the destination port in the UR; it is the proxy
+                This is not the destination port in the URL; it is the proxy
                 port to which the client browser is pointed.</p>
 <p>Call after <code class="code">TXN_START_HOOK</code>.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The port number in host byte order.</p>
-<p>Returns -1 if an error occurred.</p>
+<p>Returns <code>-1</code> if an error occurred.</p>
 </dd>
 </dl></div>
 </div>
@@ -204,7 +239,7 @@
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>The client IP address.</p>
-<p>Returns 0 if an error occurred.</p>
+<p>Returns <code>0</code> if an error occurred.</p>
 </dd>
 </dl></div>
 </div>
@@ -282,8 +317,8 @@
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the client request header does not exist or if there is an error, then <code class="function">INKHttpTxnClientReqGet</code>
-                returns 0.</p>
-<p>Otherwise, 1 is returned.</p>
+                returns <code>0</code>.</p>
+<p>Otherwise, <code>1</code> is returned.</p>
 </dd>
 </dl>
 </div>
@@ -315,8 +350,8 @@
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
 <p>If the client response header does not exist or if there is an error, then
-                <code class="function">INKHttpTxnClientRespGet</code> returns 0.</p>
-<p>Otherwise, 1 is returned.</p>
+                <code class="function">INKHttpTxnClientRespGet</code> returns <code>0</code>.</p>
+<p>Otherwise, <code>1</code> is returned.</p>
 </dd>
 </dl></div>
 </div>
@@ -354,11 +389,11 @@
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Sets the format of the error body  Traffic Server
+<p>Sets the format of the error body  that Traffic Server
                 sends back when sending an error or response to a client. The
                 error body data is stored in the buffer
                 <code class="code"><em class="replaceable"><code>buf</code></em></code>. If the error body
-                is just plain text, then setting mimetype to <code class="code">NULL</code>
+                is just plain text, then setting <code class="code"><em class="replaceable"><code>mimetype </code></em></code> to <code class="code">NULL</code>
                 works fine. If the error body is HTML, then
                 <code class="code"><em class="replaceable"><code>mimetype </code></em></code> should be
                 "<code class="code">text/html</code>". If the error body is a JPEG image,
@@ -447,7 +482,7 @@
 <p>Returns the IP address of the next server from which
                 Traffic Server attempts to retrieve the request, in network
                 byte order.</p>
-<p>Returns 0 if an error occurred.</p>
+<p>Returns <code>0</code> if an error occurred.</p>
 </dd>
 </dl></div>
 </div>
@@ -502,10 +537,9 @@
                 <em class="replaceable"><code>port</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>This can be used to overwrite the value set in
-                <code class="filename">records.config</code> for the parameter
-                <code><i>proxy.config.http.parent_proxies, </i></code> or in the
-                <code class="filename">parent.config</code> file.</p>
+<p>This can be used to overwrite the value set in the
+                <code class="filename">parent.config</code> file, or in <code class="filename">records.config</code> for the parameter
+                <code><i>proxy.config.http.parent_proxies</i></code>.</p>
 <p>Call before or within
                 <code class="code">CACHE_LOOKUP_COMPLETE</code>.</p>
 </dd>
@@ -535,13 +569,13 @@
     wants the transaction to continue. If
     <code class="code">INK_EVENT_HTTP_ERROR</code> is specified for
     <code class="code"><em class="replaceable"><code>event</code></em></code>, then the plugin
-    wants the transaction to be terminated; an error is then 
-    sent back to the client if no response has already been
-    sent.</p>
+    wants the transaction to be terminated and an error is  
+    sent back to the client (if no response has already been
+    sent).</p>
   <p>You must always reenable the HTTP transaction after 
       each transaction event is processed. However, you should never reenable
     twice - this is a serious error.</p>
-  <p>When event is set to <code class="code">INK_EVENT_HTTP_ERROR</code>,
+  <p>When <code class="code"><em class="replaceable"><code>event </code></em></code>  is set to <code class="code">INK_EVENT_HTTP_ERROR</code>,
     Traffic Server performs different processing depending on the
     type of hook involved.</p>
   <ul>
@@ -596,7 +630,7 @@
 <dd>
 <p>Returns the IP address of the origin server specified by
                 the client request in network byte order.
-                <code class="function">INKHttpTxnServerIPGet</code> returns 0 if it is
+                <code class="function">INKHttpTxnServerIPGet</code> returns <code>0</code> if it is
                 called before <code class="code">INK_HTTP_OS_DNS_HOOK</code> in a
                 transaction.</p>
 <p>Call after <code class="code">INK_HTTP_OS_DNS_HOOK</code>.</p>
@@ -605,7 +639,7 @@
 <dd>
 <p>Returns the origin server IP address in network byte
                 order.</p>
-<p>Returns 0 if an error occurred.</p>
+<p>Returns <code>0</code> if an error occurred.</p>
 </dd>
 </dl></div>
 </div>
@@ -637,8 +671,8 @@
 <dd>
 <p>If the server request header does not exist or in the
                 case of an error, then
-                <code class="function">INKHttpTxnServerReqGet</code> returns 0.</p>
-<p>Otherwise, it returns 1.</p>
+                <code class="function">INKHttpTxnServerReqGet</code> returns <code>0</code>.</p>
+<p>Otherwise, it returns <code>1</code>.</p>
 </dd>
 </dl></div>
 </div>
@@ -670,8 +704,8 @@
 <dd>
 <p>If the server response header does not exist or if there
                 is an error, then
-                <code class="function">INKHttpTxnServerRespGet</code> returns 0.</p>
-<p>Otherwise, 1 is returned.</p>
+                <code class="function">INKHttpTxnServerRespGet</code> returns <code>0</code>.</p>
+<p>Otherwise, <code>1</code> is returned.</p>
 </dd>
 </dl></div>
 </div>
@@ -732,10 +766,10 @@
                   document can be cached, then this function determines if the transformed version should be cached. Untransformed and
                   transformed documents are cached as HTTP alternates.</p></td></tr>
 </table></div>
-<p>Call from within or after hook
+<p>Call from within or after the hook
                 <code class="code">TXN_START_HOOK</code>.</p>
 <p>If called after hook <code class="code">SEND_RESPONSE_HDR</code>,
-                then this function will not be taken into account by Traffic Server.</p>
+                then this function is not taken into account by Traffic Server.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
@@ -770,8 +804,8 @@
 <dd>
 <p>If the transform response header does not exist, then
                 <code class="function">INKHttpTxnTransformRespGet</code> returns
-                0.</p>
-<p>Otherwise, 1 is returned.</p>
+                <code>0</code>.</p>
+<p>Otherwise, <code>1</code> is returned.</p>
 </dd>
 </dl></div>
 </div>
@@ -789,10 +823,9 @@
 <dd>
 <p>Specifies whether the untransformed document should be
                 written to the cache. If there is no transformation
-                occurring, then the untransformed copy will
-                be written to the cache (by default). If a transformation is occurring, then the untransformed copy will not be written to
-                the cache (by default). The defaults maintain a rule that only a single
-                version of a document is  written to the cache for a
+                occurring, then the untransformed copy is written to the cache (by default). If a transformation is occurring, then the untransformed copy is not written to
+                the cache (by default). The default rules dictate that only a single
+                version of a document is written to the cache for a
                 single transaction. It is valid for that rule to be broken by
                 specifying that both the transformed and untransformed
                 document be written to the cache. Calls need to be made prior
@@ -812,7 +845,7 @@
 <p>Call from within or after hook
                 <code class="code">TXN_START_HOOK</code>.</p>
 <p>If called after hook <code class="code">SEND_RESPONSE_HDR</code>,
-                then Traffic Server will not take this function into account.</p>
+                then Traffic Server does not take this function into account.</p>
 </dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>