Merged revisions 1902-1905 via svnmerge from

svn+ssh://projects.linpro.no/svn/varnish/trunk/varnish-cache

........
  r1902 | des | 2007-08-20 21:13:37 +0200 (Mon, 20 Aug 2007) | 2 lines
  
  Render <code> elements.
........
  r1903 | des | 2007-08-20 21:16:08 +0200 (Mon, 20 Aug 2007) | 2 lines
  
  Really render <code> elements correctly.
........
  r1904 | des | 2007-08-20 21:17:49 +0200 (Mon, 20 Aug 2007) | 4 lines
  
  At some point along the line, I forgot that these files aren't actually
  DocBook, and that I don't have <filename>, <literal>, <varname> etc. -
  just <code>.
........
  r1905 | des | 2007-08-20 21:20:25 +0200 (Mon, 20 Aug 2007) | 2 lines
  
  Rewrap (no content changes)
........


git-svn-id: http://www.varnish-cache.org/svn/branches/1.1@1906 d4fa192b-c00b-0410-8231-f00ffab90ce4

doc/changes-1.0.4-1.1.xml

@@ -13,8 +13,8 @@
     </change>
 
     <change type="enh" ref="1389">
-      <para>Equality (<literal>==</literal>) and inequality
-      (<literal>!=</literal>) operators have been implemented for IP
+      <para>Equality (<code>==</code>) and inequality
+      (<code>!=</code>) operators have been implemented for IP
       addresses (which previously could only be compared using
       ACLs).</para>
     </change>
@@ -22,16 +22,16 @@
     <change type="enh" ref="1390">
       <para>The address of the listening socket on which the client
       connection was received is now available to VCL as the
-      <varname>server.ip</varname> variable.</para>
+      <code>server.ip</code> variable.</para>
     </change>
 
     <change type="enh" ref="1395,1397,1398">
       <para>Each object's hash key is now computed based on a string
-      which is available to VCL as <varname>req.hash</varname>.  A VCL
-      hook named <varname>vcl_hash</varname> has been added to allow
-      VCL scripts to control hash generation (for instance, whether or
-      not to include the value of the <literal>Host:</literal> header
-      in the hash).</para>
+      which is available to VCL as <code>req.hash</code>.  A VCL hook
+      named <code>vcl_hash</code> has been added to allow VCL scripts
+      to control hash generation (for instance, whether or not to
+      include the value of the <code>Host:</code> header in the
+      hash).</para>
     </change>
 
     <change type="bug" ref="1423,1559">
@@ -53,21 +53,20 @@
     <change type="enh" ref="1482">
       <para>The child process will now drop root privileges
       immediately upon startup.  The user and group to use are
-      specified with the <varname>user</varname> and
-      <varname>group</varname> run-time parameters, which default to
-      <literal>nobody</literal> and <literal>nogroup</literal>,
-      respectively.  Other changes have been made in an effort to
-      increase the isolation between parent and child, and reduce the
-      impact of a compromise of the child process.</para>
+      specified with the <code>user</code> and <code>group</code>
+      run-time parameters, which default to <code>nobody</code> and
+      <code>nogroup</code>, respectively.  Other changes have been
+      made in an effort to increase the isolation between parent and
+      child, and reduce the impact of a compromise of the child
+      process.</para>
     </change>
 
     <change type="enh" ref="1506">
       <para>Objects which are received from the backend with a
-      <literal>Vary:</literal> header are now stored separately
-      according to the values of the headers specified in
-      <literal>Vary:</literal>.  This allows Varnish to correctly
-      cache e.g. compressed and uncompressed versions of the same
-      object.</para>
+      <code>Vary:</code> header are now stored separately according to
+      the values of the headers specified in <code>Vary:</code>.  This
+      allows Varnish to correctly cache e.g. compressed and
+      uncompressed versions of the same object.</para>
     </change>
 
     <change type="enh" ref="1521,1524,1525,1526,1528,1532,1533,1572,1573,1581">
@@ -81,9 +80,9 @@
     </change>
 
     <change type="enh" ref="1549">
-      <para>When invoked with the <option>-C</option> option,
-      <command>varnishd</command> will now not just translate the VCL
-      code to C, but also compile the C code and attempt to load the
+      <para>When invoked with the <code>-C</code> option,
+      <code>varnishd</code> will now not just translate the VCL code
+      to C, but also compile the C code and attempt to load the
       resulting shared object.</para>
     </change>
 
@@ -94,26 +93,25 @@
     </change>
 
     <change type="enh" ref="1557,1558">
-      <para>The new command-line option <option>-F</option> will make
-      <command>varnishd</command> run in the foreground, without
-      enabling debugging.</para>
+      <para>The new command-line option <code>-F</code> will make
+      <code>varnishd</code> run in the foreground, without enabling
+      debugging.</para>
     </change>
 
     <change type="enh" ref="1560">
       <para>New VCL variables have been introduced to allow inspection
       and manipulation of the request sent to the backend
-      (<varname>bereq.request</varname>, <varname>bereq.url</varname>,
-      <varname>bereq.proto</varname> and
-      <varname>bereq.http</varname>) and the response to the client
-      (<varname>resp.proto</varname>, <varname>resp.status</varname>,
-      <varname>resp.response</varname> and
-      <varname>resp.http</varname>).</para>
+      (<code>bereq.request</code>, <code>bereq.url</code>,
+      <code>bereq.proto</code> and <code>bereq.http</code>) and the
+      response to the client (<code>resp.proto</code>,
+      <code>resp.status</code>, <code>resp.response</code> and
+      <code>resp.http</code>).</para>
     </change>
 
     <change type="enh" ref="1564,1565">
       <para>Statistics from the storage code (including the amount of
       data and free space in the cache) are now available to
-      <command>varnishstat</command> and other statistics-gathering
+      <code>varnishstat</code> and other statistics-gathering
       tools.</para>
     </change>
 
@@ -122,44 +120,44 @@
       up-to-date (to within a few seconds).  When cache runs out, the
       objects at the tail end of the LRU list are discarded one by one
       until there is enough space for the freshly requested object(s).
-      A VCL hook, <function>vcl_discard</function>, is allowed to
-      inspect each object and determine its fate by returning either
-      <command>keep</command> or <command>discard</command>.</para>
+      A VCL hook, <code>vcl_discard</code>, is allowed to inspect each
+      object and determine its fate by returning either
+      <code>keep</code> or <code>discard</code>.</para>
     </change>
 
     <change type="enh" ref="1612,1640">
-      <para>A new VCL hook, <function>vcl_deliver</function>, provides
-      a chance to adjust the response before it is sent to the
+      <para>A new VCL hook, <code>vcl_deliver</code>, provides a
+      chance to adjust the response before it is sent to the
       client.</para>
     </change>
 
     <change type="enh" ref="1626">
-      <para>A new management command, <command>vcl.show</command>,
-      displays the VCL source code of any loaded configuration.</para>
+      <para>A new management command, <code>vcl.show</code>, displays
+      the VCL source code of any loaded configuration.</para>
     </change>
 
     <change type="enh" ref="1628">
-      <para>A new VCL variable, <varname>now</varname>, provides VCL
-      scripts with the current time in seconds since the epoch.</para>
+      <para>A new VCL variable, <code>now</code>, provides VCL scripts
+      with the current time in seconds since the epoch.</para>
     </change>
 
     <change type="enh" ref="1628,1629,1630">
-      <para>A new VCL variable, <varname>obj.lastuse</varname>,
-      reflects the time in seconds since the object in question was
-      last used.</para>
+      <para>A new VCL variable, <code>obj.lastuse</code>, reflects the
+      time in seconds since the object in question was last
+      used.</para>
     </change>
 
     <change type="enh" ref="1645,1646,1648">
       <para>VCL scripts can now add an HTTP header (or modify the
       value of an existing one) by assigning a value to the
       corresponding variable, and strip an HTTP header by using the
-      <command>remove</command> keyword.</para>
+      <code>remove</code> keyword.</para>
     </change>
 
     <change type="enh" ref="1661,1662">
       <para>VCL scripts can now modify the HTTP status code of cached
-      objects (<varname>obj.status</varname>) and responses
-      (<varname>resp.status</varname>)</para>
+      objects (<code>obj.status</code>) and responses
+      (<code>resp.status</code>)</para>
     </change>
 
     <change type="enh" ref="1663">
@@ -170,13 +168,13 @@
 
     <change type="enh" ref="1666,1667">
       <para>VCL scripts can now apply regular expression substitutions
-      to textual variables using the <function>regsub</function>
+      to textual variables using the <code>regsub</code>
       function.</para>
     </change>
 
     <change type="enh" ref="1674,1675">
-      <para>A new management command, <command>status</command>,
-      returns the state of the child.</para>
+      <para>A new management command, <code>status</code>, returns the
+      state of the child.</para>
     </change>
 
     <change type="enh" ref="1719-1721">
@@ -190,7 +188,7 @@
     <change type="enh" ref="1502">
       <para>This is a new utility which sends a single command to a
       Varnish server's management port and prints the result to
-      <varname>stdout</varname>, greatly simplifying the use of the
+      <code>stdout</code>, greatly simplifying the use of the
       management port from scripts.</para>
     </change>
   </subsystem>
@@ -212,13 +210,12 @@
     <name>varnishncsa</name>
 
     <change type="enh" ref="1479">
-      <para>In addition to client traffic,
-      <command>varnishncsa</command> can now also process log data
-      from backend traffic.</para>
+      <para>In addition to client traffic, <code>varnishncsa</code>
+      can now also process log data from backend traffic.</para>
     </change>
 
     <change type="bug" ref="1531">
-      <para>A bug that would cause <command>varnishncsa</command> to
+      <para>A bug that would cause <code>varnishncsa</code> to
       segfault when it encountered an empty HTTP header in the log
       file has been fixed.</para>
     </change>
@@ -241,17 +238,17 @@
       <para>Don't print lifetime averages when it doesn't make any
       sense&mdash;for instance, there is no point in dividing the
       amount in bytes of free cache space by the lifetime in seconds
-      of the <command>varnishd</command> process.</para>
+      of the <code>varnishd</code> process.</para>
     </change>
 
     <change type="enh" ref="1589,1590,1591">
       <para>The user interface has been greatly improved;
-      <command>varnishstat</command> will no longer print more than
-      fits in the terminal, and will respond correctly to window
-      resize events.  The output produced in one-shot mode has been
-      modified to include symbolic names for each entry.  In addition,
-      the name of the Varnish instance being watched is displayed in
-      the upper right corner in curses mode.</para>
+      <code>varnishstat</code> will no longer print more than fits in
+      the terminal, and will respond correctly to window resize
+      events.  The output produced in one-shot mode has been modified
+      to include symbolic names for each entry.  In addition, the name
+      of the Varnish instance being watched is displayed in the upper
+      right corner in curses mode.</para>
     </change>
   </subsystem>
 
@@ -260,10 +257,10 @@
 
     <change type="enh" ref="1592,1596">
       <para>The user interface has been greatly improved;
-      <command>varnishtop</command> will now respond correctly to
-      window resize events, and one-shot mode (<option>-1</option>)
-      actually works.  In addition, the name of the Varnish instance
-      being watched is displayed in the upper right corner in curses
+      <code>varnishtop</code> will now respond correctly to window
+      resize events, and one-shot mode (<code>-1</code>) actually
+      works.  In addition, the name of the Varnish instance being
+      watched is displayed in the upper right corner in curses
       mode.</para>
     </change>
   </subsystem>

doc/changes-1.1-1.1.1.xml

@@ -9,14 +9,14 @@
 
     <change type="bug" ref="1745">
       <para>The code required to allow VCL to read
-      <varname>obj.status</varname>, which had accidentally been left
-      out, has now been added.</para>
+      <code>obj.status</code>, which had accidentally been left out,
+      has now been added.</para>
     </change>
 
     <change type="bug" ref="1750">
-      <para>Varnish will now always include a
-      <literal>Connection:</literal> header in its reply to the
-      client, to avoid possible misunderstandings.</para>
+      <para>Varnish will now always include a <code>Connection:</code>
+      header in its reply to the client, to avoid possible
+      misunderstandings.</para>
     </change>
 
     <change type="buf" ref="1751">
@@ -25,18 +25,18 @@
     </change>
 
     <change type="enh" ref="1761,1762,1765,1828">
-      <para>A new VCL function, <function>purge_url</function>,
-      provides the same functionality as the
-      <command>url.purge</command> management command.</para>
+      <para>A new VCL function, <code>purge_url</code>, provides the
+      same functionality as the <code>url.purge</code> management
+      command.</para>
     </change>
 
     <change type="enh" ref="1780">
       <para>Previously, Varnish assumed that the response body should
-      be sent only if the request method was <literal>GET</literal>.
-      This was a problem for custom request methods (such as
-      <literal>PURGE</literal>), so the logic has been changed to
-      always send the response body except in the specific case of a
-      <literal>HEAD</literal> request.</para>
+      be sent only if the request method was <code>GET</code>.  This
+      was a problem for custom request methods (such as
+      <code>PURGE</code>), so the logic has been changed to always
+      send the response body except in the specific case of a
+      <code>HEAD</code> request.</para>
     </change>
 
     <change type="bug" ref="1795">
@@ -46,11 +46,10 @@
 
     <change type="bug" ref="1797">
       <para>Due to the way run-time parameters are initialized at
-      startup, <command>varnishd</command> previously required the
-      <literal>nobody</literal> user and the
-      <literal>nogroup</literal> group to exist even if a different
-      user and group were specified on the command line.  This has
-      been corrected.</para>
+      startup, <code>varnishd</code> previously required the
+      <code>nobody</code> user and the <code>nogroup</code> group to
+      exist even if a different user and group were specified on the
+      command line.  This has been corrected.</para>
     </change>
 
     <change type="bug" ref="1800">
@@ -66,18 +65,17 @@
     </change>
 
     <change type="bug" ref="1807">
-      <para>Before calling <function>vcl_miss</function>, Varnish
-      assembles a tentative request object for the backend request
-      which will usually follow.  This object would be leaked if
-      <function>vcl_miss</function> returned anything else than
-      <command>fetch</command>.  This has been corrected.</para>
+      <para>Before calling <code>vcl_miss</code>, Varnish assembles a
+      tentative request object for the backend request which will
+      usually follow.  This object would be leaked if
+      <code>vcl_miss</code> returned anything else than
+      <code>fetch</code>.  This has been corrected.</para>
     </change>
 
     <change type="bug" ref="1808">
-      <para>The code necessary to handle an <command>error</command>
-      return from <function>vcl_fetch</function> and
-      <function>vcl_deliver</function> had inadvertantly been left
-      out.  This has been corrected.</para>
+      <para>The code necessary to handle an <code>error</code> return
+      from <code>vcl_fetch</code> and <code>vcl_deliver</code> had
+      inadvertantly been left out.  This has been corrected.</para>
     </change>
 
     <change type="bug" ref="1810">
@@ -109,8 +107,7 @@
 
     <change type="bug" ref="1752">
       <para>The top-level Makefile will now honor
-      <varname>$DESTDIR</varname> when creating the state
-      directory.</para>
+      <code>$DESTDIR</code> when creating the state directory.</para>
     </change>
 
     <change type="enh" ref="1743,1846">
@@ -124,16 +121,16 @@
     </change>
 
     <change type="enh" ref="1811">
-      <para>The <filename>autogen.sh</filename> script had workarounds
-      for problems with the GNU autotools on FreeBSD; these are no
-      longer needed and have been removed.</para>
+      <para>The <code>autogen.sh</code> script had workarounds for
+      problems with the GNU autotools on FreeBSD; these are no longer
+      needed and have been removed.</para>
     </change>
 
     <change type="enh" ref="1817">
-      <para>The <filename>libcompat</filename> library has been
-      renamed to <filename>libvarnishcompat</filename> and is now
-      dynamic rather than static.  This simplifies the build process
-      and resolves an issue with the Mac OS X linker.</para>
+      <para>The <code>libcompat</code> library has been renamed to
+      <code>libvarnishcompat</code> and is now dynamic rather than
+      static.  This simplifies the build process and resolves an issue
+      with the Mac OS X linker.</para>
     </change>
   </subsystem>
 </group>

doc/changes-html.xsl

@@ -72,4 +72,21 @@
       <xsl:value-of select="@ref"/>
     </a>
   </xsl:template>
+
+  <xsl:template match="code">
+    <span>
+      <xsl:attribute name="class">
+	<xsl:value-of select="name()"/>
+      </xsl:attribute>
+      <xsl:apply-templates/>
+    </span>
+  </xsl:template>
+
+  <xsl:template match="*" priority="-1">
+    <xsl:message>Warning: no template for element <xsl:value-of select="name(
+)"/></xsl:message>
+    <xsl:value-of select="concat('&lt;', name(), '&gt;')"/>
+    <xsl:apply-templates/>
+    <xsl:value-of select="concat('&lt;/', name(), '&gt;')"/>
+  </xsl:template>
 </xsl:stylesheet>

doc/changes.css

@@ -25,3 +25,7 @@ h3 {
 	font-weight: bold;
 	color: maroon;
 }
+
+.code {
+	font-family: monospace;
+}