r4922 - in trunk/varnish-cache/doc/sphinx: . reference

perbu at varnish-cache.org perbu at varnish-cache.org
Mon Jun 7 10:35:11 CEST 2010


Author: perbu
Date: 2010-06-07 10:35:10 +0200 (Mon, 07 Jun 2010)
New Revision: 4922

Modified:
   trunk/varnish-cache/doc/sphinx/index.rst
   trunk/varnish-cache/doc/sphinx/reference/varnishd.rst
Log:
intro + some layout

Modified: trunk/varnish-cache/doc/sphinx/index.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/index.rst	2010-06-07 08:19:51 UTC (rev 4921)
+++ trunk/varnish-cache/doc/sphinx/index.rst	2010-06-07 08:35:10 UTC (rev 4922)
@@ -1,17 +1,17 @@
 .. Varnish documentation master file, created by
    sphinx-quickstart on Tue Apr 20 13:02:15 2010.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
 Welcome to Varnish's documentation!
 ===================================
 
-Arnold's Laws of Documentation:
-        (1) If it should exist, it doesn't.
-        (2) If it does exist, it's out of date.
-        (3) Only documentation for useless programs transcends the
-            first two laws.
+Varnish is a state of the art web accelerator. Its mission is to sit
+in front of a web server an cache the content. It makes your web site
+go fast.
 
+We suggest you start by reading the :ref:`_Installation`. Once you
+have Varnish up and running go through the :ref:`_tutorial-index`.
+
+
 Contents:
 
 .. toctree::

Modified: trunk/varnish-cache/doc/sphinx/reference/varnishd.rst
===================================================================
--- trunk/varnish-cache/doc/sphinx/reference/varnishd.rst	2010-06-07 08:19:51 UTC (rev 4921)
+++ trunk/varnish-cache/doc/sphinx/reference/varnishd.rst	2010-06-07 08:35:10 UTC (rev 4922)
@@ -794,17 +794,17 @@
 The argument could be a quoted string, a regexp, or an integer.  Integers can have "KB", "MB", "GB" or "TB"
 appended for size related fields.
 
-Simple example: All requests where req.url exactly matches the string /news are purged from the cache.
+Simple example: All requests where req.url exactly matches the string /news are purged from the cache:::
 
     req.url == "/news"
 
 Example: Purge all documents where the name does not end with ".ogg", and where the size of the object is greater
-than 10 megabytes.
+than 10 megabytes:::
 
     req.url !~ "\.ogg$" && obj.size > 10MB
 
 Example: Purge all documents where the serving host is "example.com" or "www.example.com", and where the Set-
-Cookie header received from the backend contains "USERID=1663".
+Cookie header received from the backend contains "USERID=1663":::
 
     req.http.host ~ "^(www\.)example.com$" && obj.set-cookie ~ "USERID=1663"
 




More information about the varnish-commit mailing list