From 3297552f650a9ff097c569e28256872b476078d0 Mon Sep 17 00:00:00 2001 From: Daniel Quackenbush Date: Sat, 21 Jul 2018 11:30:41 -0400 Subject: [PATCH] Updated readme with build status, updated docs --- README.md | 6 +----- docs/ansible.rst | 26 +++++++++++++------------- 2 files changed, 14 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 2250f1b2..43075a2e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,4 @@ # Mitogen -<<<<<<< HEAD -[![Build Status](https://travis-ci.org/dw/mitogen.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) -======= -[![Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=c%2B%2B11)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) ->>>>>>> fcc10e644ee217743480940e4184a5bba1955487 +[![Build Status](https://travis-ci.org/dw/mitogen.png?branch=master)](https://travis-ci.org/dw/mitogen}) Please see the documentation. diff --git a/docs/ansible.rst b/docs/ansible.rst index e53ecf8e..b667fd37 100644 --- a/docs/ansible.rst +++ b/docs/ansible.rst @@ -58,7 +58,7 @@ Installation ------------ 1. Thoroughly review the :ref:`noteworthy_differences` and :ref:`changelog`. -2. Verify Ansible 2.3-2.5 and Python 2.6, 2.7 or 3.6 are listed in ``ansible +2. Verify Ansible 2.3-2.6.1 and Python 2.6, 2.7 or 3.6 are listed in ``ansible --version`` output. 3. Download and extract |mitogen_url| from PyPI. 4. Modify ``ansible.cfg``: @@ -130,12 +130,12 @@ Noteworthy Differences * The ``doas``, ``su`` and ``sudo`` become methods are available. File bugs to register interest in more. -* The `docker `_, - `jail `_, - `local `_, - `lxc `_, - `lxd `_, - and `ssh `_ +* The `docker `_, + `jail `_, + `local `_, + `lxc `_, + `lxd `_, + and `ssh `_ built-in connection types are supported, along with Mitogen-specific :ref:`machinectl `, :ref:`mitogen_doas< mitogen_doas>`, :ref:`mitogen_su `, :ref:`mitogen_sudo `, and :ref:`setns ` @@ -507,7 +507,7 @@ Docker ~~~~~~ Like `docker -`_ except +`_ except connection delegation is supported. * ``ansible_host``: Name of Docker container (default: inventory hostname). @@ -534,7 +534,7 @@ FreeBSD Jail ~~~~~~~~~~~~ Like `jail -`_ except +`_ except connection delegation is supported. * ``ansible_host``: Name of jail (default: inventory hostname). @@ -545,7 +545,7 @@ Local ~~~~~ Like `local -`_ except +`_ except connection delegation is supported. * ``ansible_python_interpreter`` @@ -556,8 +556,8 @@ connection delegation is supported. LXC ~~~ -Like `lxc `_ -and `lxd `_ +Like `lxc `_ +and `lxd `_ except connection delegation is supported, and ``lxc-attach`` is always used rather than the LXC Python bindings, as is usual with ``lxc``. @@ -646,7 +646,7 @@ When used as the ``mitogen_sudo`` connection method: SSH ~~~ -Like `ssh `_ +Like `ssh `_ except connection delegation is supported. * ``ansible_ssh_timeout``