[master] b8f32b9 Squash more warnings
Lasse Karstensen
lkarsten at varnish-software.com
Thu Mar 20 16:06:49 CET 2014
commit b8f32b911ef11e626ceb116851e66ea8a76a2367
Author: Lasse Karstensen <lkarsten at varnish-software.com>
Date: Thu Mar 20 15:51:24 2014 +0100
Squash more warnings
diff --git a/doc/sphinx/index.rst b/doc/sphinx/index.rst
index 11b4cce..db8b5a5 100644
--- a/doc/sphinx/index.rst
+++ b/doc/sphinx/index.rst
@@ -14,7 +14,7 @@ architecture.
To get started with Varnish-Cache we recommend that you read the installation
guide :ref:`install-index`. Once you have Varnish up and running we recommend
that you go through our tutorial - :ref:`tutorial-index`, and finally the
-:ref:`users_guide_index`.
+:ref:`users-guide-index`.
If you need to find out how to use a specific Varnish tool, the
:ref:`reference-index` contains detailed documentation over the tools. Changes
diff --git a/doc/sphinx/reference/varnishadm.rst b/doc/sphinx/reference/varnishadm.rst
index 5bb9f6e..8143abd 100644
--- a/doc/sphinx/reference/varnishadm.rst
+++ b/doc/sphinx/reference/varnishadm.rst
@@ -1,3 +1,5 @@
+.. _ref-varnishadm:
+
==========
varnishadm
==========
diff --git a/doc/sphinx/reference/varnishhist.rst b/doc/sphinx/reference/varnishhist.rst
index 8071384..685aebe 100644
--- a/doc/sphinx/reference/varnishhist.rst
+++ b/doc/sphinx/reference/varnishhist.rst
@@ -1,3 +1,5 @@
+.. _ref-varnishhist:
+
===========
varnishhist
===========
diff --git a/doc/sphinx/reference/varnishncsa.rst b/doc/sphinx/reference/varnishncsa.rst
index 2902f6b..77086ac 100644
--- a/doc/sphinx/reference/varnishncsa.rst
+++ b/doc/sphinx/reference/varnishncsa.rst
@@ -1,3 +1,5 @@
+.. _ref-varnishncsa:
+
===========
varnishncsa
===========
diff --git a/doc/sphinx/reference/varnishstat.rst b/doc/sphinx/reference/varnishstat.rst
index 3505526..4178778 100644
--- a/doc/sphinx/reference/varnishstat.rst
+++ b/doc/sphinx/reference/varnishstat.rst
@@ -1,4 +1,4 @@
-.. _reference-varnishstat:
+.. _ref-varnishstat:
===========
varnishstat
@@ -13,6 +13,8 @@ SYNOPSIS
varnishstat [-1] [-x] [-j] [-f field_list] [-l] [-n varnish_name] [-N filename] [-V] [-w delay]
+.. TODO: autogenerate this synopsis like the others.
+
DESCRIPTION
===========
diff --git a/doc/sphinx/reference/varnishtest.rst b/doc/sphinx/reference/varnishtest.rst
index a3a0eec..bfae5a5 100644
--- a/doc/sphinx/reference/varnishtest.rst
+++ b/doc/sphinx/reference/varnishtest.rst
@@ -1,3 +1,5 @@
+.. _ref-varnishtest:
+
===========
varnishtest
===========
diff --git a/doc/sphinx/reference/varnishtop.rst b/doc/sphinx/reference/varnishtop.rst
index 4692143..e1abbcb 100644
--- a/doc/sphinx/reference/varnishtop.rst
+++ b/doc/sphinx/reference/varnishtop.rst
@@ -1,3 +1,5 @@
+.. _ref-varnishtop:
+
==========
varnishtop
==========
diff --git a/doc/sphinx/users-guide/sizing-your-cache.rst b/doc/sphinx/users-guide/sizing-your-cache.rst
index 497ce0e..90621f8 100644
--- a/doc/sphinx/users-guide/sizing-your-cache.rst
+++ b/doc/sphinx/users-guide/sizing-your-cache.rst
@@ -2,26 +2,26 @@
Sizing your cache
-----------------
-Deciding on cache size can be a tricky
-task. A few things to consider:
+Deciding on cache size can be a tricky task. A few things to consider:
* How big is your *hot* data set. For a portal or news site that
would be the size of the front page with all the stuff on it, and
- the size of all the pages and objects linked from the first page.
+ the size of all the pages and objects linked from the first page.
+
* How expensive is it to generate an object? Sometimes it makes sense
to only cache images a little while or not to cache them at all if
they are cheap to serve from the backend and you have a limited
amount of memory.
- * Watch the `n_lru_nuked` counter with :ref:`reference-varnishstat` or
+
+ * Watch the `n_lru_nuked` counter with :ref:`ref-varnishstat` or
some other tool. If you have a lot of LRU activity then your cache
is evicting objects due to space constraints and you should
consider increasing the size of the cache.
Be aware that every object that is stored also carries overhead that
-is kept outside the actually storage area. So, even if you specify '-s
-malloc,16G' Varnish might actually use **double** that. Varnish has a
-overhead of about 1k per object. So, if you have lots of small objects
+is kept outside the actually storage area. So, even if you specify ``-s
+malloc,16G`` Varnish might actually use **double** that. Varnish has a
+overhead of about 1KB per object. So, if you have lots of small objects
in your cache the overhead might be significant.
.. XXX:This seems to contradict the last paragraph in "storage-backends". benc
-
diff --git a/doc/sphinx/users-guide/vcl-backends.rst b/doc/sphinx/users-guide/vcl-backends.rst
index c54d951..77347c4 100644
--- a/doc/sphinx/users-guide/vcl-backends.rst
+++ b/doc/sphinx/users-guide/vcl-backends.rst
@@ -180,34 +180,32 @@ define the backends.::
}
}
-Whats new here is the ``probe``. Varnish will check the health of each
+What is new here is the ``probe``. Varnish will check the health of each
backend with a probe. The options are:
url
The URL Varnish will use to send a probe request.
interval
- How often should we poll
+ How often should we poll.
timeout
- What is the timeout of the probe
+ What is the timeout of the probe.
window
- Varnish will maintain a *sliding window* of the results. Here the
- window has five checks.
+ Varnish will retain up to this many probes when considering backend health.
threshold
- How many of the '.window' last polls must be good for the backend to be declared healthy.
-
-.. XXX: .window probably means something but not to me :) benc
+ How many of the `.window` last polls must be good for the backend to be
+ declared healthy.
initial
- How many of the probes that needs to be succesful when Varnish starts - defaults
- to the same amount as the threshold.
+ How many of the probes that needs to be succesful when Varnish starts.
+ Defaults to the same amount as the threshold.
-Now we define the 'director'.::
.. XXX: Where and why? benc
+Now we define the 'director'::
import directors;
@@ -222,10 +220,10 @@ unhealthy. Varnish can also serve stale content if all the backends are
down. See :ref:`users-guide-handling_misbehaving_servers` for more
information on how to enable this.
-Please note that Varnish will keep probes active for all loaded
-VCLs. Varnish will coalesce probes that seem identical - so be careful
-not to change the probe config if you do a lot of VCL
-loading. Unloading the VCL will discard the probes.
+Please note that Varnish will keep probes active for all loaded VCLs. Varnish
+will coalesce probes that seem identical - so be careful not to change the
+probe config if you do a lot of VCL loading. Unloading the VCL will discard the
+probes.
For more information on how to do this please see
ref:`reference-vcl-director`.
diff --git a/doc/sphinx/users-guide/vcl.rst b/doc/sphinx/users-guide/vcl.rst
index 8585241..86ed8cf 100644
--- a/doc/sphinx/users-guide/vcl.rst
+++ b/doc/sphinx/users-guide/vcl.rst
@@ -42,8 +42,5 @@ code commented out in the file `builtin.vcl` that ships with Varnish Cache.
vcl-grace
vcl-inline-c
vcl-examples
- websockets
-.. XXX: websockets seems to be missing? does it refer to the last sample in the vcl index if so already included. benc
-
devicedetection
More information about the varnish-commit
mailing list