summaryrefslogtreecommitdiff
path: root/doc/example
diff options
context:
space:
mode:
authorholger krekel <holger@merlinux.eu>2010-07-08 11:25:38 +0200
committerholger krekel <holger@merlinux.eu>2010-07-08 11:25:38 +0200
commit7f630e8dbf15213f2f6fe68a9cf205b5b2fa3b34 (patch)
tree88661550d37dc858bb960ee9ecc62ecdddf3fb23 /doc/example
parent9656b177f04d172609927b4e955668a29fc49ad2 (diff)
downloadtox-7f630e8dbf15213f2f6fe68a9cf205b5b2fa3b34.tar.gz
various doc fixes
Diffstat (limited to 'doc/example')
-rw-r--r--doc/example/general.txt6
-rw-r--r--doc/example/hudson.txt33
2 files changed, 20 insertions, 19 deletions
diff --git a/doc/example/general.txt b/doc/example/general.txt
index 1649602..ebdd443 100644
--- a/doc/example/general.txt
+++ b/doc/example/general.txt
@@ -105,11 +105,11 @@ Example ``tox.ini`` for project ``two``::
{distshare}/two-*.zip # install latest package from "two" project
Tox running on project ``one`` will copy the sdist-package into the
-``distshare`` directory after a ``tox` run on project ``two`` will
-grab it because the ``deps`` contain an entry with the
+``distshare`` directory after which a ``tox`` run on project ``two`` will
+grab it because ``deps`` contain an entry with the
``two-*.zip`` pattern. If there is more than one matching package
the highest version will be taken. ``tox`` uses verlib_ to
-compare version strings which must be compliant with :pep:`385`.
+compare version strings which must be compliant with :pep:`386`.
.. _verlib: http://bitbucket.org/tarek/distutilsversion/
.. include:: ../links.txt
diff --git a/doc/example/hudson.txt b/doc/example/hudson.txt
index 65dafab..4a28d52 100644
--- a/doc/example/hudson.txt
+++ b/doc/example/hudson.txt
@@ -50,13 +50,11 @@ and does not need to be in use or installed with any other environment.
Access package artifacts between Hudson jobs
--------------------------------------------------------
-.. _`general artifact exchange mechanism`: general.html#artifacts
.. _`Hudson Copy Artifact plugin`: http://wiki.hudson-ci.org/display/HUDSON/Copy+Artifact+Plugin
-In an extension to the `general artifact exchange mechanism`_
-you can configure Hudson jobs to access each other artifacts.
-As far as ``tox`` is concerned you should configure a special
-directory for the hudson context like this::
+In an extension to :ref:`artifacts` you can configure Hudson jobs to
+access each others artifacts. ``tox`` allows to define
+global variables in a per-hudson context like this::
[tox:hudson]
distshare=.tox/distshare
@@ -65,17 +63,20 @@ This means that each workspace will have its own ``distshare``
directory and we need to configure some artifact copying.
The recommend way to do this is to install the `Hudson Copy Artifact plugin`_
and for each job which "receives" artifacts you add a **Copy artifacts from another project**
-build step using roughly this configuration:
-
- ``Project-name``: the name of the other (tox-managed) job you want the artifact from
- ``Artifacts to copy``: ``.tox/dist/*.zip
- ``Target directory``: .tox/distshare
- Flatten Directories: CHECK
-
-If you add such a build step at the beginning then Hudson will
-copy the other artifact into our ``distshare`` directory
-and thus ``tox`` will be able to find it like
-in the non-Hudson case.
+build step using roughly this configuration::
+
+ Project-name: the name of the other (tox-managed) job you want the artifact from
+ Artifacts to copy: .tox/dist/*.zip # where the other jobs creates its artifacts
+ Target directory: .tox/distshare # where we want it to appear for us
+ Flatten Directories: CHECK # copy files flatly, create no subdir-structure
+
+If you add such a build step before your ``tox`` run the latter
+can install the dependency just like :ref:`artifacts` shows it.
+In other words, the only difference in ``tox.ini`` between Hudson
+and non-Hudson artifact sharing is the value for the ``distshare``
+directory which can be set separately so that the rest of your
+``tox.ini`` is fully re-useable and can be debugged on a
+developer console.
.. include:: ../links.txt