[master] 7bc370950 improve backend.list documentation

Nils Goroll nils.goroll at uplex.de
Mon Feb 4 14:38:09 UTC 2019


commit 7bc37095037539eec9570e72f2c4fb13518434a9
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Mon Feb 4 15:31:05 2019 +0100

    improve backend.list documentation
    
    * move -p documentation from CLI "help backend.list" to sphinx
    
    * Add note on the fact that the health state as seen from VCL may differ

diff --git a/include/tbl/cli_cmds.h b/include/tbl/cli_cmds.h
index 57efeaab6..6c020f072 100644
--- a/include/tbl/cli_cmds.h
+++ b/include/tbl/cli_cmds.h
@@ -257,8 +257,13 @@ CLI_CMD(DEBUG_LISTEN_ADDRESS,
 CLI_CMD(BACKEND_LIST,
 	"backend.list",
 	"backend.list [-j] [-p] [<backend_pattern>]",
-	"List backends.  -p also shows probe status.",
-	"``-j`` specifies JSON output.",
+	"List backends.\n",
+	"  ``-p`` also shows probe status.\n\n"
+	"  ``-j`` specifies JSON output.\n\n"
+	"  The health state reported here is generic. A backend's health "
+	"may also depend on the context it is being used in (e.g. "
+	"the object's hash), so the actual health state as visible "
+	"from VCL (e.g. using std.healthy()) may differ.",
 	0, 2
 )
 


More information about the varnish-commit mailing list