[master] 3d90373df backend.list doc

[Nils Goroll]

commit 3d90373df69e7f0ceac3f0f91b11b469ff377d40
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Tue Mar 5 12:21:11 2019 +0100

    backend.list doc

diff --git a/include/tbl/cli_cmds.h b/include/tbl/cli_cmds.h
index 0bc1e0f0f..ee0da1bd5 100644
--- a/include/tbl/cli_cmds.h
+++ b/include/tbl/cli_cmds.h
@@ -273,25 +273,35 @@ CLI_CMD(BACKEND_LIST,
 	"  ``-p`` also shows probe status.\n\n"
 	"  ``-j`` specifies JSON output.\n\n"
 	"  Unless ``-j`` is specified for JSON output, "
-	" the output format is four columns of dynamic width, "
+	" the output format is five columns of dynamic width, "
 	" separated by white space with the fields:\n\n"
 	"  * Backend name\n\n"
 	"  * Admin: How health state is determined:\n\n"
-	"    * healthy: Set healthy through backend.set_health.\n\n"
-	"    * sick: Set sick through backend.set_health.\n\n"
-	"    * probe: Health state determined by a probe.\n\n"
-	"    * deleted: Backend has been deleted, but not yet cleaned up.\n\n"
-	/* XXX #2896 TBD */
-	"  * Probe: Summary of probe checks:\n\n"
-	"    * healthy\n\n"
-	"    * sick\n\n"
-	"    * x/y {good,bad}: The backend is good or bad by x/y measure (e.g."
-	" probes or number of backends in a director\n\n"
+	"    * ``healthy``: Set ``healthy`` through ``backend.set_health``.\n\n"
+	"    * ``sick``: Set ``sick`` through ``backend.set_health``.\n\n"
+	"    * ``probe``: Health state determined by a probe or some other\n"
+	"      dynamic mechanism.\n\n"
+	"    * ``deleted``: Backend has been deleted, but not yet cleaned\n"
+	"      up.\n\n"
+	"    Admin has precedence over Health\n\n"
+	"  * Probe *X*\\ /\\ *Y*: *X* out of *Y* checks have succeeded\n\n"
+	"    *X* and *Y* are backend specific and may represent probe checks,\n"
+	"    other backends or any other metric.\n\n"
+	"    If there is no probe or the director does not provide details on\n"
+	"    probe check results, ``0/0`` is output.\n\n"
+	"  * Health: Probe health state\n\n"
+	"    * ``healthy``\n\n"
+	"    * ``sick``\n\n"
+	"    If there is no probe, ``healthy`` is output.\n"
 	"  * Last change: Timestamp when the health state last changed.\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.",
+	"from VCL (e.g. using ``std.healthy()``) may differ.\n\n"
+	"  For ``-j``, the object members should be self explanatory,\n"
+	"  matching the fields described above. ``probe_message`` has the\n"
+	"  format ``[X, Y, \"state\"]`` as described above for Probe. JSON\n"
+	"  Probe details (``-j -p`` arguments) are director specific.",
 	0, 2
 )