Add receptorctl work cancel doc and doc lint make targets (#1055)

docs/Makefile

@@ -11,11 +11,24 @@ BUILDDIR      = build
 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@echo -e "  doc8        doc8 linter"
+	@echo -e "  lint        All documentation linters (including linkcheck)"
+	@echo -e "  rstcheck    rstcheck linter"
 
-.PHONY: help Makefile server
+.PHONY: doc8 help lint Makefile rstcheck server
+
+doc8:
+	doc8 --ignore D001 .
+
+# Documentation linters
+lint: doc8 linkcheck rstcheck
+
+rstcheck:
+	-rstcheck --recursive --warn-unknown-settings .
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+# Includes linkcheck
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 

docs/requirements.txt

@@ -1,4 +1,6 @@
+doc8
 pbr
+rstcheck >= 6
 six
 sphinx
 sphinx_ansible_theme

docs/source/receptorctl/receptorctl_index.rst

@@ -15,4 +15,5 @@ The Receptor client, ``receptorctl``, provides a command line interface for inte
    receptorctl_status
    receptorctl_traceroute
    receptorctl_version
+   receptorctl_work_cancel
    receptorctl_work_list

docs/source/receptorctl/receptorctl_work_cancel.rst

@@ -0,0 +1,26 @@
+-----------
+work cancel
+-----------
+
+.. contents::
+   :local:
+
+``receptorctl work cancel`` terminates one or more units of work.
+
+Command syntax: ``receptorctl --socket=<socket_path> work cancel <<Unit ID>> [...]``
+
+``socket_path`` is the control socket address for the Receptor connection.
+   The default is ``unix:`` for a Unix socket.
+   Use ``tcp://`` for a TCP socket.
+   The corresponding environment variable is ``RECEPTORCTL_SOCKET``.
+
+.. code-block:: text
+
+  ss --listening --processes --unix 'src = unix:<socket_path>'
+  Netid         State          Recv-Q         Send-Q                   Local Address:Port                     Peer Address:Port        Process
+  u_str         LISTEN         0              4096                   /tmp/local.sock 38130170                            * 0            users:(("receptor",pid=3226769,fd=7))
+
+``ps -fp $(pidof receptor)``
+``lsof -p <pid>``
+
+``Unit ID`` is a unique identifier for a work unit (job).  When running the ``work cancel`` command, you should specify the ``Unit ID`` for the Receptor instance to which you are connected.