From 64f521656c1f8063e2eacbc1939dae89974598ec Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Sat, 16 Dec 2017 19:35:21 +0100
Subject: [PATCH] Update README for neutron-horizon-hack

Let's describe the API we need for tox_install.sh.

Change-Id: I5155ebffd3c7e8ec1f354b2afd6dfcb3986795fe
---
 roles/neutron-horizon-hack/README.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/roles/neutron-horizon-hack/README.rst b/roles/neutron-horizon-hack/README.rst
index 61a97379..2a7b3471 100644
--- a/roles/neutron-horizon-hack/README.rst
+++ b/roles/neutron-horizon-hack/README.rst
@@ -9,6 +9,11 @@ inside of a virtualenv, so we can just run it in the sphinx ~/.venv and
 get them installed. This will let us work towards a solution that does not
 involve a custom install script.
 
+Note that this role only works if the file is called
+``tools/tox_install.sh`` and takes three arguments
+``constraints-file``, ``opts`` and ``packages``. The script must allow
+invocation with the single ``constraints-file`` argument as well.
+
 **Role Variables**
 
 .. zuul:rolevar:: constraints_file