[master] 43b981048 use references which work both for html and man pages

Nils Goroll nils.goroll at uplex.de
Tue Aug 28 15:45:11 UTC 2018


commit 43b981048816948b5fbd17db4f54486b055991c2
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Tue Aug 28 17:39:06 2018 +0200

    use references which work both for html and man pages

diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index d720dbc95..7aa434da6 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -200,8 +200,7 @@ Example::
         */
     }
 
-
-.. _ref_backend_def:
+.. _backend_definition:
 
 Backend definition
 ------------------
@@ -241,17 +240,17 @@ parameters. The following attributes are available:
   ``.connect_timeout``
     Timeout for connections.
 
-    Default: :ref:`ref_param_connect_timeout` parameter.
+    Default: ``connect_timeout`` parameter, see :ref:`varnishd(1)`
 
   ``.first_byte_timeout``
     Timeout for first byte.
 
-    Default: :ref:`ref_param_first_byte_timeout` parameter.
+    Default: ``first_byte_timeout`` parameter, see :ref:`varnishd(1)`
 
   ``.between_bytes_timeout``
     Timeout between bytes.
 
-    Default: :ref:`ref_param_between_bytes_timeout` parameter.
+    Default: ``between_bytes_timeout`` parameter, see :ref:`varnishd(1)`
 
   ``.probe``
     Attach a probe to the backend. See `Probes`_
diff --git a/doc/sphinx/reference/vcl_var.rst b/doc/sphinx/reference/vcl_var.rst
index 28044f145..b54c654e4 100644
--- a/doc/sphinx/reference/vcl_var.rst
+++ b/doc/sphinx/reference/vcl_var.rst
@@ -587,9 +587,9 @@ bereq.connect_timeout
 
 	Default:
 
-	* :ref:`ref_backend_def` ``.connect_timeout`` attribute, which
-	   defaults to
-	* :ref:`ref_param_connect_timeout` parameter.
+	* ``.connect_timeout`` attribute from the
+	  :ref:`backend_definition`, which defaults to the
+	* ``connect_timeout`` parameter, see :ref:`varnishd(1)`
 
 	The time in seconds to wait for a backend connection to be
 	established.
@@ -605,9 +605,9 @@ bereq.first_byte_timeout
 
 	Default:
 
-	* :ref:`ref_backend_def` ``.first_byte_timeout`` attribute,
-	   which defaults to
-	* :ref:`ref_param_first_byte_timeout` parameter.
+	* ``.first_byte_timeout`` attribute from the
+	  :ref:`backend_definition`, which defaults to the
+	* ``first_byte_timeout`` parameter, see :ref:`varnishd(1)`
 
 	The time in seconds to wait getting the first byte back
 	from the backend.  Not available in pipe mode.
@@ -623,9 +623,9 @@ bereq.between_bytes_timeout
 
 	Default:
 
-	* :ref:`ref_backend_def` ``.between_bytes_timeout`` backend
-	   attribute, which defaults to
-	* :ref:`ref_param_between_bytes_timeout` parameter.
+	* ``.between_bytes_timeout`` attribute from the
+	  :ref:`backend_definition`, which defaults to the
+	* ``between_bytes_timeout`` parameter, see :ref:`varnishd(1)`
 
 	The time in seconds to wait between each received byte from the
 	backend.  Not available in pipe mode.


More information about the varnish-commit mailing list