Merge pull request #327 from dw/dmw

v0.2.2 final touches

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+
+Feel free to write an issue in your preferred format, however if in doubt, use
+the following checklist as a guide for what to include.
+
+* Have you tried the latest master version from Git?
+* Mention your host and target OS and versions
+* Mention your host and target Python versions
+* If reporting a performance issue, mention the number of targets and a rough
+  description of your workload (lots of copies, lots of tiny file edits, etc.)
+* If reporting a crash or hang in Ansible, please rerun with -vvvv and include
+  the last 200 lines of output, along with a full copy of any traceback or
+  error text in the log. Beware "-vvvv" may include secret data! Edit as
+  necessary before posting.
+* If reporting any kind of problem with Ansible, please include the Ansible
+  version along with output of "ansible-config dump --only-changed".

docs/ansible.rst

@@ -79,8 +79,8 @@ Installation
        deploy = (ALL) NOPASSWD:/usr/bin/python -c*
 
 5. Subscribe to the `mitogen-announce mailing list
-   <https://www.freelists.org/list/mitogen-announce>`_ in order to stay up to
-   date with new releases and important bug fixes.
+   <https://www.freelists.org/list/mitogen-announce>`_ to stay updated with new
+   releases and important bug fixes.
 
 
 Demo
@@ -702,7 +702,7 @@ controller with ``-vvvv`` or higher.
 
 Although use of standard IO and the logging package on the target is forwarded
 to the controller, it is not possible to receive IO activity logs, as the
-processs of receiving those logs would would itself generate IO activity. To
+process of receiving those logs would would itself generate IO activity. To
 receive a complete trace of every process on every machine, file-based logging
 is necessary. File-based logging can be enabled by setting
 ``MITOGEN_ROUTER_DEBUG=1`` in your environment.
@@ -711,7 +711,8 @@ When file-based logging is enabled, one file per context will be created on the
 local machine and every target machine, as ``/tmp/mitogen.<pid>.log``.
 
 If you are experiencing a hang, ``MITOGEN_DUMP_THREAD_STACKS=1`` causes every
-process to dump every thread stack into the logging framework every 5 seconds.
+process on every machine to dump every thread stack into the logging framework
+every 5 seconds.
 
 
 Getting Help

docs/changelog.rst

@@ -25,7 +25,7 @@ Release Notes
       <https://github.com/danquack>`_.
 
 
-v0.2.2 (2018-07-??)
+v0.2.2 (2018-07-26)
 -------------------
 
 Mitogen for Ansible
@@ -87,9 +87,6 @@ Core Library
   could spuriously wake up due to ignoring an error bit set on events returned
   by the kernel, manifesting as a failure to read from an unrelated descriptor.
 
-* Debug logs containing command lines are printed with the minimal quoting and
-  escaping required.
-
 * Standard IO forwarding accidentally configured the replacement ``stdout`` and
   ``stderr`` write descriptors as non-blocking, causing subprocesses that
   generate more output than kernel buffer space existed to throw errors. The
@@ -98,6 +95,9 @@ Core Library
 * When :func:`mitogen.core.enable_profiling` is active, :mod:`mitogen.service`
   threads are profiled just like other threads.
 
+* Debug logs containing command lines are printed with the minimal quoting and
+  escaping required.
+
 
 Thanks!
 ~~~~~~~
@@ -110,7 +110,7 @@ the bug reports and pull requests in this release contributed by
 `Colin McCarthy <https://github.com/colin-mccarthy>`_,
 `Dan Quackenbush <https://github.com/danquack>`_,
 `Duane Zamrok <https://github.com/dewthefifth>`_,
-`Frances Albanese <https://github.com/falbanese>`_,
+`falbanese <https://github.com/falbanese>`_,
 `Gonzalo Servat <https://github.com/gservat>`_,
 `Guy Knights <https://github.com/knightsg>`_,
 `Josh Smift <https://github.com/jbscare>`_,
@@ -196,6 +196,12 @@ Mitogen for Ansible
   for Message(..., 102, ...), my ID is ...* may be visible. These are due to a
   minor race while initializing logging and can be ignored.
 
+* When running with ``-vvv``, log messages will be printed to the console
+  *after* the Ansible run completes, as connection multiplexer shutdown only
+  begins after Ansible exits. This is due to a lack of suitable shutdown hook
+  in Ansible, and is fairly harmless, albeit cosmetically annoying. A future
+  release may include a solution.
+
 * Performance does not scale linearly with target count. This requires
   significant additional work, as major bottlenecks exist in the surrounding
   Ansible code. Performance-related bug reports for any scenario remain

mitogen/__init__.py

@@ -33,7 +33,7 @@ be expected. On the slave, it is built dynamically during startup.
 
 
 #: Library version as a tuple.
-__version__ = (0, 2, 1)
+__version__ = (0, 2, 2)
 
 
 #: This is :data:`False` in slave contexts. Previously it was used to prevent