From b89d73a268f5162e954d100895bee4e8445f93dd Mon Sep 17 00:00:00 2001 From: pcrews Date: Wed, 10 Sep 2014 12:11:55 -0700 Subject: [PATCH] Document multiple images in dox Altering the README file to properly describe how dox works with multiple images. This includes how / where to specify them and how dox uses them (executes the same prep/command code on each image). This is to better reflect behavior w/ new multiple image patch. Change-Id: Iba45177e6989c30d12d0b823956b2e5e07206176 --- README.rst | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 8ffc48e..1777ce9 100644 --- a/README.rst +++ b/README.rst @@ -108,6 +108,19 @@ re-installing the source into the system can be minimized. Advanced -------- -The dox.yml file can reference multiple images, such as if your test suite -needs things like a MySQL server. At least, that's the theory. This is not -yet implemented. +It is possible to specify multiple images to be used in a dox run. +Images can be provided on the command line, via the dox.yml file, or the +tox.ini file. + +For the command line, images should be provided via the --images option, +in a comma-separated list. + +The tox.ini file should also use a comma-separated list. + +The dox.yml file should list images in an array. + +The same prep and command instructions will be executed on each image sequentially. + +dox does not currently allow for multiple images executing different tasks +at this time. However, it is a goal to allow for such test scenarios in +the future.