openstack/ironic
Code Issues Proposed changes

Merge "Drop some outdated information from our quick start guide"

Browse Source
This commit is contained in:
Jenkins 2015-11-24 14:28:37 +00:00 committed by Gerrit Code Review
commit 4f62cd9719
1 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/source/dev/dev-quickstart.rst
View File

@ -12,9 +12,9 @@ The gate currently runs the unit tests under both
Python 2.7 and Python 3.4. It is strongly encouraged to run the unit tests Python 2.7 and Python 3.4. It is strongly encouraged to run the unit tests
locally under one, the other, or both prior to submitting a patch. locally under one, the other, or both prior to submitting a patch.
.. Note:: The unit test environment setup should be done on a clean installed .. note::
VM or system. Sharing the environment with devstack testing is not Do not run unit tests on the same environment as devstack due to
recommended due to conflicting configuration with system dependencies. conflicting configuration with system dependencies.
.. seealso:: .. seealso::
@ -59,10 +59,10 @@ Using Python 3.4:
sudo dnf install python3-devel sudo dnf install python3-devel
Install these on all distros:: If your distro has at least tox 1.8, use similar command to install
``python-tox`` package. Otherwise install this on all distros::
sudo easy_install nose sudo pip install -U tox
sudo pip install virtualenv setuptools-git flake8 tox testrepository
You may need to explicitly upgrade virtualenv if you've installed the one You may need to explicitly upgrade virtualenv if you've installed the one
@ -78,16 +78,12 @@ Ironic source code should be pulled directly from git::
git clone https://git.openstack.org/openstack/ironic git clone https://git.openstack.org/openstack/ironic
cd ironic cd ironic
Set up a local environment for development and testing should be done with tox:: Set up a local environment for development and testing should be done with tox,
for example::
# create a virtualenv for development # create a virtualenv for development
tox -evenv --notest tox -evenv --notest
Activate the virtual environment whenever you want to work in it.
All further commands in this section should be run with the venv active::
source .tox/venv/bin/activate
All unit tests should be run using tox. To run Ironic's entire test suite:: All unit tests should be run using tox. To run Ironic's entire test suite::
# run all tests (unit under both py27 and py34, and pep8) # run all tests (unit under both py27 and py34, and pep8)
@ -114,10 +110,6 @@ To run only the pep8/flake8 syntax and style checks::
tox -epep8 tox -epep8
When you're done, deactivate the virtualenv::
deactivate
=============================== ===============================
Exercising the Services Locally Exercising the Services Locally
=============================== ===============================