[master] 1469881 Improve general documentation on parameters and link to the list of them

Nils Goroll nils.goroll at uplex.de
Fri May 12 14:53:05 CEST 2017

commit 146988123a466f6d06c64e4894354886fa715342
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Fri May 12 12:55:08 2017 +0200

    Improve general documentation on parameters and link to the list of them

diff --git a/doc/sphinx/reference/varnishd.rst b/doc/sphinx/reference/varnishd.rst
index 3b34004..931fbb9 100644
--- a/doc/sphinx/reference/varnishd.rst
+++ b/doc/sphinx/reference/varnishd.rst
@@ -421,6 +421,8 @@ relative to the values listed below, in order to conserve VM space:
 * gzip_stack_buffer: 4k
 * thread_pool_stack: 64k
+.. _List of Parameters:
 List of Parameters
diff --git a/doc/sphinx/users-guide/params.rst b/doc/sphinx/users-guide/params.rst
index 5422c98..3fc5cd2 100644
--- a/doc/sphinx/users-guide/params.rst
+++ b/doc/sphinx/users-guide/params.rst
@@ -4,26 +4,13 @@ Parameters
 Varnish Cache comes with a set of parameters that affects behaviour and
-performance. Most of these parameters can be set on the Varnish
-command line (through `varnishadm`) using the ``param.set`` keyword.
-Some parameters can, for security purposes be read only using the '-r'
-command line switch to `varnishd`.
+performance. Parameters are set either though command line
+arguments to ``varnishd`` or at runtime through ``varnishadm`` using
+the ``param.set`` CLI command.
 We don't recommend that you tweak parameters unless you're sure of what
 you're doing. We've worked hard to make the defaults sane and Varnish
 should be able to handle most workloads with the default settings.
-For a complete listing of all the parameters and a short descriptions
-type ``param.show`` in the CLI. To inspect a certain parameter and get
-a somewhat longer description on what it does and what the default is
-type ``param.show`` and the name of the parameter, like this::
-  varnish> param.show shortlived
-  200
-  shortlived                  10.000000 [s]
-                              Default is 10.0
-                              Objects created with TTL shorter than this are
-                              always put in transient storage.
+For a complete listing of all parameters and their specifics see
+:ref:`List of Parameters`.

More information about the varnish-commit mailing list