trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dia...@apache.org
Subject svn commit: r906692 - /incubator/trafficserver/site/trunk/docs/sdk/
Date Thu, 04 Feb 2010 22:23:43 GMT
Author: dianes
Date: Thu Feb  4 22:23:42 2010
New Revision: 906692

URL: http://svn.apache.org/viewvc?rev=906692&view=rev
Log:
fixed errata previously overlooked in 1st pass

Modified:
    incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html
    incubator/trafficserver/site/trunk/docs/sdk/INKIsDebugTagSet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMBufferDestroy.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMgmtFloatGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMgmtIntGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMgmtStringGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMutexLock.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMutexLockTry.html
    incubator/trafficserver/site/trunk/docs/sdk/INKMutexUnlock.html
    incubator/trafficserver/site/trunk/docs/sdk/INKNetConnect.html
    incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemoteIPGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemotePortGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKPluginDirGet.html
    incubator/trafficserver/site/trunk/docs/sdk/INKPluginLicenseRequired.html
    incubator/trafficserver/site/trunk/docs/sdk/INKPluginRegister.html
    incubator/trafficserver/site/trunk/docs/sdk/INKReleaseAssert.html
    incubator/trafficserver/site/trunk/docs/sdk/INKmalloc.html
    incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html
    incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html
    incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIOBufferWrite.html Thu Feb  4 22:23:42
2010
@@ -57,7 +57,7 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKIOBufferWrite"></a>INKIOBufferWrite</h3></div></div></div>
-<p>Appends the specified number of bytes from a buffer to the IO
+<p>Appends the specified number of bytes from a particular buffer to the IO
         buffer.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
@@ -67,7 +67,7 @@
               <em class="replaceable"><code>len</code></em>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="function">INKIOBuffer</code>
+<p><code class="function">INKIOBuffer </code>
               <code class="code"><em class="replaceable"><code>bufp </code></em></code>
is the target
               IOBuffer that receives the data.</p>
 <p><code class="code">const char <em class="replaceable"><code>*buf
</code></em></code> is
@@ -77,10 +77,10 @@
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>This function appends data from
+  <p>This function appends data from 
               <code class="code"><em class="replaceable"><code>*buf</code></em>
</code>to IOBuffer
               <code class="code"><em class="replaceable"><code>bufp</code></em></code>;
the length of data
-              being appended is given in
+              being appended is specified in
               <code class="code"><em class="replaceable"><code>len</code></em></code>.
The returned value
               is the actual length of data being appended.</p></dd>
 <dt><span class="term"><b>Example</b></span></dt>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKIsDebugTagSet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKIsDebugTagSet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKIsDebugTagSet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKIsDebugTagSet.html Thu Feb  4 22:23:42
2010
@@ -64,20 +64,20 @@
               ...</code></em>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="code"><em class="replaceable"><code>fmt</code></em></code>
is the printf
+<p><code class="code"><em class="replaceable"><code>fmt </code></em></code>
is the printf
               format description.</p>
-<p><code class="code">...</code> is the argument for the format
+<p><code class="replaceable">... </code> is the argument for the format
               description.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p>Since it is sometimes useful to log messages when errors occur,
-              Traffic Server has a global error log file for this purpose. The function <code>INKError</code>
is the API interface to
+              Traffic Server provides a global error log file for this purpose. The function
<code>INKError</code> is the API interface to
               this error log. <code>INKError</code> is similar to <code>printf</code>,
except that
               <code>INKError</code> writes output to the Traffic Server error
log instead of writing the output to the C standard output. One advantage of <code>INKError</code>
over <code>printf</code> is that each call is atomically placed into
-              the error log and is not garbled with other error entries. This
+              the error log and is not garbled with other error entries (this
               is not an issue in single-threaded programs, but is a definite
-      nuisance in multi-threaded programs.</p></dd>
+      nuisance in multi-threaded programs).</p></dd>
 <dt><span class="term"><b>Example</b></span></dt>
 <dd><pre class="programlisting">INKError ("couldn't retrieve client request header\n");</pre></dd>

 </dl></div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMBufferDestroy.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMBufferDestroy.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMBufferDestroy.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMBufferDestroy.html Thu Feb  4 22:23:42
2010
@@ -67,10 +67,11 @@
   <p><code class="code"><em class="replaceable"><code>bufp </code></em></code>
is the
               marshal buffer to be destroyed.</p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Ignores the reference count and destroys the marshal
+<dd>
+  <p>Ignores the reference count and destroys the marshal
               buffer <code class="code"><em class="replaceable"><code>bufp</code></em></code>.
The
               internal data buffer associated with the marshal buffer is also
-              destroyed if the marshal buffer allocated it.</p></dd>
+              destroyed (if the marshal buffer allocated it).</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMgmtFloatGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMgmtFloatGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMgmtFloatGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMgmtFloatGet.html Thu Feb  4 22:23:42 2010
@@ -57,32 +57,32 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKMgmtFloatGet"></a>INKMgmtFloatGet</h3></div></div></div>
-<p>Get a <code class="filename">records.config</code> variable of type
+<p>Gets a <code class="filename">records.config</code> variable of type
         <code class="code">float</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">int INKMgmtFloatGet (const char *<i>var_name</i>,
-              INKMgmtFloat *<i>result</i>)</code></p></dd>
+<dd><p><code class="code">int INKMgmtFloatGet (const char *<i class="replaceable">var_name</i>,
+      INKMgmtFloat *<i class="replaceable">result</i>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="code"><i>var_name </i></code> is the name of
the variable you want
+<p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
               from <code class="filename">records.config</code>.</p>
-<p><code class="code"><i>result </i></code> is a pointer to
the value of the
-              variable; this value is of type
+<p><code class="replaceable"><i>result </i></code> is a pointer
to the value of the
+              variable, which is of type
               <code class="function">INKMgmtFloat</code>.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p><code class="function">INKMgmtFloatGet</code> obtains the value of
               the specified <code class="filename">records.config</code> variable
of
-              type <code class="code">float</code>, and then stores the value
in
-              <code class="code">result</code>.</p></dd>
+              type <code class="code">float</code>, and then stores the value
in 
+      <code class="replaceable">result</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-  <p>If <code class="function">INKMgmtFloatGet</code> could not get the
+  <p>If <code class="function">INKMgmtFloatGet</code> cannot get the
               variable, then it returns zero. </p></dd>
 <dd>
-  <p>If it was successful, then a nonzero value
+  <p>If successful, then a nonzero value
     is returned.</p>
 </dd>
 </dl>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMgmtIntGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMgmtIntGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMgmtIntGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMgmtIntGet.html Thu Feb  4 22:23:42 2010
@@ -65,17 +65,16 @@
               *<i>result</i>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="code"><i>var_name </i></code> is the name of
the variable you want
+<p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
               from <code class="filename">records.config</code>.</p>
-<p><code class="code"><i>result </i></code> is a pointer to
the value of the
-              variable; this value is of type <code class="code">INKMgmtInt</code>.</p>
+<p><code class="replaceable"><i>result </i></code> is a pointer
to the variable's value, which is of type <code class="code">INKMgmtInt</code>.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
   <p><code class="function">INKMgmtIntGet</code> obtains the value of
               the specified <code class="filename">records.config</code> variable
of
-              type <code class="code">int</code>, and then stores the value in
-              <code class="code">result</code>.</p></dd>
+              type <code class="code">int</code>, and then stores the value in

+      <code class="replaceable">result</code>.</p></dd>
               
          <dt><span class="term"><b>Example</b></span></dt>
 <dd>
@@ -93,11 +92,11 @@
 <dt>&nbsp;</dt>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p>If <code class="function">INKMgmtIntGet</code> could not get the
-        variable, then it returns zero. </p>
+<p>If <code class="function">INKMgmtIntGet</code> cannot get the
+        variable, then zero is returned. </p>
 </dd>
 <dd>
-  <p>If it was successful, then it returns a nonzero value.</p>
+  <p>If  successful, then it returns a nonzero value.</p>
 </dd>
 </dl>
 </div></div></body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMgmtStringGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMgmtStringGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMgmtStringGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMgmtStringGet.html Thu Feb  4 22:23:42
2010
@@ -64,9 +64,9 @@
               INKMgmtString *<i>result</i>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code class="code"><i>var_name </i></code> is the name of
the variable you want
+<p><code class="replaceable"><i>var_name </i></code> is the
name of the variable you want
               from <code class="filename">records.config</code></p>
-<p><code class="code"><i>result </i></code> is a pointer to
the value of the
+<p><code class="replaceable"><i>result </i></code> is a pointer
to the value of the
               variable. This value is of type
               <code class="code">INKMgmtString</code>.</p>
 </dd>
@@ -74,9 +74,9 @@
 <dd>
 <p><code class="function">INKMgmtStringGet</code> obtains the value of
               the specified <code class="filename">records.config</code> variable
of
-              type <code class="code">String</code>, and then stores the value
in
-              <code class="code">result</code>.</p>
-<p>When done with the result, your plugin must deallocate the
+              type <code class="code">String</code>, and then stores the value
in 
+              <code class="replaceable">result</code>.</p>
+<p>When it's finished with the result, your plugin must deallocate the
               result string with a call to
               <code class="function">INKfree</code>.</p>
 </dd>
@@ -85,7 +85,7 @@
   <p>If <code class="function">INKMgmtStringGet</code> could not get the
               variable, then it returns zero. </p></dd>
 <dd>
-  <p>If it was successful, then a nonzero value
+  <p>If  successful, then a nonzero value
     is returned.</p>
 </dd>
 </dl>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMutexLock.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMutexLock.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMutexLock.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMutexLock.html Thu Feb  4 22:23:42 2010
@@ -64,13 +64,13 @@
               <em class="replaceable"><code>mutexp</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Locks the <code class="function">INKMutex</code>
+  <p>Locks the <code class="function">INKMutex </code>
               <code class="code"><em class="replaceable"><code>mutexp</code></em></code>.
If
               <code class="code"><em class="replaceable"><code>mutexp </code></em></code>
is already locked,
               then <code class="function">INKMutexLock</code>  blocks until the
               mutex is unlocked. An <code class="function">INKMutex</code> will
be
               recursively locked if <code class="function">INKMutexLock</code>
is
-              called on the same mutex twice from the same thread. That means 
+              called on the same mutex twice from the same thread. Thus,  
               the following example will succeed and not block on the second
               call to <code class="function">INKMutexLock</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMutexLockTry.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMutexLockTry.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMutexLockTry.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMutexLockTry.html Thu Feb  4 22:23:42 2010
@@ -65,7 +65,7 @@
               *<em class="replaceable"><code>lock</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Tries to lock the <code class="function">INKMutex</code>
+<p>Tries to lock the <code class="function">INKMutex </code>
               <code class="code"><em class="replaceable"><code>mutex</code></em></code>.
Information about 
               whether the lock was grabbed is set in <code class="code">int
               *</code><code class="code"><em class="replaceable"><code>lock</code></em></code>.

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKMutexUnlock.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKMutexUnlock.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKMutexUnlock.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKMutexUnlock.html Thu Feb  4 22:23:42 2010
@@ -60,11 +60,11 @@
 <p>Unlocks an <code class="code">INKMutex</code>.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
-<dd><p><code class="code">INKReturnCode INKMutexUnlock (INKMutex
+<dd><p><code class="code">INKReturnCode INKMutexUnlock (INKMutex 
               <em class="replaceable"><code>mutexp</code></em>)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Unlocks the <code class="function">INKMutex</code>
+  <p>Unlocks the <code class="function">INKMutex </code>
               <code class="code"><em class="replaceable"><code>mutexp</code></em></code>.
If
               <code class="code"><em class="replaceable"><code>mutexp </code></em></code>
was recursively
               locked, then <code class="function">INKMutexUnlock</code> does
not

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKNetConnect.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKNetConnect.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKNetConnect.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKNetConnect.html Thu Feb  4 22:23:42 2010
@@ -72,14 +72,14 @@
 <p><code class="code">int
               </code><code class="code"><em class="replaceable"><code>ip
</code></em></code> is the IP
               address, in network byte order, of the host to connect
-              to.</p>
+              with.</p>
 <p><code class="code">int</code>
               <code class="code"><em class="replaceable"><code>port </code></em></code>
is port number for
               the host, specified in network byte order.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Opens up a network connection to the host specified by
+<p>Opens a network connection to the host specified by
               <code class="code"><em class="replaceable"><code>ip </code></em></code>
on the port specified
               by <code class="code"><em class="replaceable"><code>port</code></em></code>.
If the
               connection is successfully opened, then 

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemoteIPGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemoteIPGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemoteIPGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemoteIPGet.html Thu Feb  4 22:23:42
2010
@@ -65,12 +65,12 @@
               *<em class="replaceable"><code>ip</code></em>)</code></p></dd>
 <dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p><code>INKVConn</code> <code class="code"><em class="replaceable"><code>vc
</code></em></code> is the
+<p><code>INKVConn </code> <code class="code"><em class="replaceable"><code>vc
</code></em></code> is the
               connection between Traffic Server and the other end of the
               connection (can be a remote client or server).</p>
 <p><code class="code">unsigned int
               *</code><code class="code"><em class="replaceable"><code>ip
</code></em></code> is set to the
-              remote IP address in network byte order.</p>
+              remote IP address, in network byte order.</p>
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd><p>Obtains the remote IP address in network byte

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemotePortGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemotePortGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemotePortGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKNetVConnRemotePortGet.html Thu Feb  4 22:23:42
2010
@@ -59,32 +59,30 @@
 <a name="INKNetVConnRemotePortGet"></a>INKNetVConnRemotePortGet</h3></div></div></div>
 <p>Retrieves the remote host’s port number.</p>
 <div class="variablelist"><dl>
-<dt><span class="term">Prototype</span></dt>
+<dt><span class="term"><b>Prototype</b></span></dt>
 <dd><p><code class="code">InkReturnCode INKNetVConnRemotePortGet (INKVConn
               <em class="replaceable"><code>vc</code></em>, int
               *<em class="replaceable"><code>port</code></em>)</code></p></dd>
-<dt><span class="term">Arguments</span></dt>
+<dt><span class="term"><b>Arguments</b></span></dt>
 <dd>
-<p>INKVConn <code class="code"><em class="replaceable"><code>vc</code></em></code>
is the
+<p><code>INKVConn <em class="replaceable">vc </em></code><code
class="code"><em class="replaceable"><code> </code></em></code>
is the
               connection between Traffic Server and the other end of the
               connection (can be remote client or server).</p>
 <p><code class="code">int
-              *</code><code class="code"><em class="replaceable"><code>port</code></em></code>
is set to
+              *</code><code class="code"><em class="replaceable"><code>port
</code></em></code> is set to
               the remote port value in host byte order.</p>
 </dd>
-<dt><span class="term">Description</span></dt>
+<dt><span class="term"><b>Description</b></span></dt>
 <dd><p>Obtains the port number of the remote host for the
               specified connection. The port is returned in host byte
               order.</p></dd>
-<dt><span class="term">Returns</span></dt>
+<dt><span class="term"><b>Returns</b></span></dt>
 <dd>
-<p><code class="code">INK_SUCCESS</code> if API is called
+<p><code class="code">INK_SUCCESS</code> if the API is called
               successfully.</p>
 <p><code class="code">INK_ERROR</code> if an error occurs while calling
               the API or if an argument is invalid.</p>
 </dd>
-<dt><span class="term">First release</span></dt>
-<dd><p>Traffic Server 5.2</p></dd>
 </dl></div>
 </div>
 </body>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKPluginDirGet.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKPluginDirGet.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKPluginDirGet.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKPluginDirGet.html Thu Feb  4 22:23:42 2010
@@ -63,7 +63,7 @@
 <dd><p><code class="code">const char * INKPluginDirGet(void)</code></p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>Get the plugin directory relative to Traffic Server’s
+<p>Gets the plugin directory relative to Traffic Server’s
               install directory. This path (relative to the Traffic Server
               install directory) is stored in the
               <code class="filename">records.config</code> variable
@@ -73,7 +73,7 @@
 <dd>
 <p>To open the file
               <code class="filename">Blacklist/ui/blacklist_config.txt</code>,
-              use</p>
+              use the following:</p>
 <pre class="programlisting">INKfopen (“INKInstallDirGet()/INKPluginDirGet()/Blacklist/ui/blacklist_config.txt”);</pre>
 </dd>
 <dt>&nbsp;</dt>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKPluginLicenseRequired.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKPluginLicenseRequired.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKPluginLicenseRequired.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKPluginLicenseRequired.html Thu Feb  4 22:23:42
2010
@@ -57,7 +57,7 @@
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h3 class="title">
 <a name="INKPluginLicenseRequired"></a>INKPluginLicenseRequired</h3></div></div></div>
-<p>Lets Traffic Server know that a license key is required for the
+<p>Specifies to Traffic Server  that a license key is required for a
         plugin.</p>
 <div class="variablelist"><dl>
 <dt><span class="term"><b>Prototype</b></span></dt>
@@ -66,8 +66,7 @@
 <dd>
   <p>Determines if a license is required. If a license is required, then Traffic
               Server looks in the <code>plugin.db</code> file for the license
key. If this
-              function is not defined, then a license is not required for the
-              plugin.</p></dd>
+      function is simply not defined, then the plugin does not require a license.</p></dd>
 <dt><span class="term"><b>Example</b></span></dt>
 <dd><pre class="programlisting">#include &lt;stdio.h&gt;
 #include "InkAPI.h"

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKPluginRegister.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKPluginRegister.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKPluginRegister.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKPluginRegister.html Thu Feb  4 22:23:42
2010
@@ -72,32 +72,32 @@
       <li><code class="code">INK_SDK_VERSION_1_1</code></li>
       <li><code class="code">INK_SDK_VERSION_2_0</code></li>
       <li><code class="code">INK_SDK_VERSION_5_2</code>
-      </li>
-    </ul>
+        </li>
+      </ul> <br/> 
+    <blockquote>
+      <p><code class="function">INKPluginRegistrationInfo</code> is the
+        following struct:</p>
+      <pre class="programlisting">typedef struct
+    {
+        char *plugin_name;
+        char *vendor_name;
+        char *support_email;
+    } INKPluginRegistrationInf</pre>
+    </blockquote>
+    </dd>
+
+      <dt><span class="term"><b>Description</b></span></dt>
+  
+  <dd>
+    <p>Registers the appropriate SDK version for your plugin. Use
+      this function to ensure that your plugin is supported by the version of Traffic Server
it's running on. See the modified <a href="PlusingRegisAndVersionCkg.html" title="Plugin
Registration and Version Checking">hello-world  example</a>  that checks Traffic
Server version for
+      usage.</p>
   </dd>
+  <dt><span class="term"><b>Returns</b></span></dt>
+  <dd>
+    <p>If  plugin registration fails, then  <code>0</code> is returned.</p></dd>
 </dl>
-  <blockquote>
-    <p><code class="function">INKPluginRegistrationInfo</code> is the
-      following struct:</p>
-    <pre class="programlisting">typedef struct
-{
-    char *plugin_name;
-    char *vendor_name;
-    char *support_email;
-} INKPluginRegistrationInf</pre></blockquote>
-  <dl>
-    <dt><span class="term"><b>Description</b></span></dt>
-    
-    <dd>
-      <p>Registers the appropriate SDK version for your plugin. Use
-        this function to make sure that the version of Traffic Server on
-        which your plugin is running supports the plugin. See the modified <a href="PlusingRegisAndVersionCkg.html"
title="Plugin Registration and Version Checking">hello-world  example</a>  that checks
Traffic Server version for
-        usage.</p>
-      </dd>
-    <dt><span class="term"><b>Returns</b></span></dt>
-    <dd><p>Returns <code>0</code> if the plugin registration fails.</p></dd>
-  </dl>
-</div>
+  </div>
 </div>
 </body>
 </html>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKReleaseAssert.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKReleaseAssert.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKReleaseAssert.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKReleaseAssert.html Thu Feb  4 22:23:42
2010
@@ -67,10 +67,9 @@
   <p>A Boolean expression.</p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-<p>If expression is false, then it causes  Traffic Server in debug
-              AND optim mode to print the file name, line number, and
-              expression; then it aborts.</p>
-<p>Allows the use of assertion in a plugin.</p>
+<p>Allows the use of assertion in a plugin. If the expression is false, then it causes
 Traffic Server in <code>debug</code> AND <code>optim</code> mode
to print the file name, line number, and
+              expression. Afterward, it aborts.</p>
+<p>&nbsp;</p>
 </dd>
 </dl></div>
 </div>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKmalloc.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKmalloc.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKmalloc.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKmalloc.html Thu Feb  4 22:23:42 2010
@@ -68,12 +68,12 @@
               of bytes to allocate.</p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Returns a pointer to <i><code>size </code></i> bytes of
memory allocated from
+  <p>Returns a pointer to <i class="replaceable"><code>size </code></i>
bytes of memory allocated from
               the heap. Traffic Server uses <code class="function">INKmalloc</code>
               internally for memory allocations. Always use
               <code class="function">INKfree</code> to release memory allocated
by
               <code class="function">INKmalloc</code>; do not use
-              <code class="code">free</code>.</p></dd>
+      <code class="code">free</code>.</p></dd>
 <dt><span class="term"><b>Returns</b></span></dt>
 <dd>
   <p>A pointer to the newly-allocated memory.</p></dd>

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKrealloc.html Thu Feb  4 22:23:42 2010
@@ -74,8 +74,8 @@
 <dd>
   <p>Changes the size of the memory block pointed to by
               <code class="code"><em class="replaceable"><code>ptr </code></em></code>
to
-              <code class="code"><em class="replaceable"><code>size </code></em></code>
bytes and returns a
-              pointer to the new block. Becaise it may not be possible to simply
+              <code class="code"><em class="replaceable"><code>size </code></em></code>
bytes, and returns a
+              pointer to the new block. Because it may not be possible to simply
               extend <code class="code"><em class="replaceable"><code>ptr
</code></em></code> to satisfy a
               request to increase the allocated block,  the returned pointer
               might point to a new block of memory. If

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKstrdup.html Thu Feb  4 22:23:42 2010
@@ -67,7 +67,8 @@
   <p><code class="code"><em class="replaceable"><code>str </code></em></code>
is a pointer
               to the null-terminated string to duplicate.</p></dd>
 <dt><span class="term"><b>Description</b></span></dt>
-<dd><p>Returns a pointer to a new string that is a duplicate of
+<dd>
+  <p>Returns a pointer to a new string that's a duplicate of
               the string pointed to by
               <code class="code"><em class="replaceable"><code>str</code></em></code>.
The memory for the
               new string is allocated using <code class="function">INKmalloc</code>
and

Modified: incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html
URL: http://svn.apache.org/viewvc/incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html?rev=906692&r1=906691&r2=906692&view=diff
==============================================================================
--- incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html (original)
+++ incubator/trafficserver/site/trunk/docs/sdk/INKstrndup.html Thu Feb  4 22:23:42 2010
@@ -73,7 +73,7 @@
 </dd>
 <dt><span class="term"><b>Description</b></span></dt>
 <dd>
-  <p>Returns a pointer to a new string that is a duplicate of
+  <p>Returns a pointer to a new string that's a duplicate of
               the string pointed to by
               <code class="code"><em class="replaceable"><code>str </code></em></code>
 that is 
               <code class="code"><em class="replaceable"><code>length </code></em></code>
bytes long. The



Mime
View raw message