Fix inaccuracies in the development environment doc.
Change-Id: If2b0884de54b75e40896cee9b4fb5eb805de2624
This commit is contained in:
parent
3814c3b86e
commit
4faa62e77e
@ -8,13 +8,13 @@ Included documents:
|
|||||||
|
|
||||||
Building the docs
|
Building the docs
|
||||||
-----------------
|
-----------------
|
||||||
From the root nova director::
|
From the root nova directory::
|
||||||
|
|
||||||
python setup.py build_sphinx
|
python setup.py build_sphinx
|
||||||
|
|
||||||
Building just the man pages
|
Building just the man pages
|
||||||
---------------------------
|
---------------------------
|
||||||
from the root nova director::
|
from the root nova directory::
|
||||||
|
|
||||||
python setup.py build_sphinx -b man
|
python setup.py build_sphinx -b man
|
||||||
|
|
||||||
@ -24,9 +24,9 @@ Installing the man pages
|
|||||||
After building the man pages, they can be found in ``doc/build/man/``.
|
After building the man pages, they can be found in ``doc/build/man/``.
|
||||||
You can install the man page onto your system by following the following steps:
|
You can install the man page onto your system by following the following steps:
|
||||||
|
|
||||||
Example for ``nova-manage``::
|
Example for ``nova-scheduler``::
|
||||||
|
|
||||||
mkdir /usr/local/man/man1
|
mkdir /usr/local/man/man1
|
||||||
install -g 0 -o 0 -m 0644 doc/build/man/nova-manage.1 /usr/local/man/man1/nova-manage.1
|
install -g 0 -o 0 -m 0644 doc/build/man/nova-scheduler.1 /usr/local/man/man1/nova-scheduler.1
|
||||||
gzip /usr/local/man/man1/nova-manage.1
|
gzip /usr/local/man/man1/nova-scheduler.1
|
||||||
man nova-manage
|
man nova-scheduler
|
||||||
|
@ -21,33 +21,31 @@ Setting Up a Development Environment
|
|||||||
This page describes how to setup a working Python development
|
This page describes how to setup a working Python development
|
||||||
environment that can be used in developing nova on Ubuntu, Fedora or
|
environment that can be used in developing nova on Ubuntu, Fedora or
|
||||||
Mac OS X. These instructions assume you're already familiar with
|
Mac OS X. These instructions assume you're already familiar with
|
||||||
git. Refer to GettingTheCode_ for additional information.
|
git.
|
||||||
|
|
||||||
.. _GettingTheCode: http://wiki.openstack.org/GettingTheCode
|
|
||||||
|
|
||||||
Following these instructions will allow you to run the nova unit
|
Following these instructions will allow you to run the nova unit
|
||||||
tests. If you want to be able to run nova (i.e., launch VM instances),
|
tests. If you want to be able to run nova (i.e., launch VM instances),
|
||||||
you will also need to install libvirt and at least one of the
|
you will also need to install libvirt and at least one of the
|
||||||
`supported hypervisors`_. Running nova is currently only supported on
|
`supported hypervisors`_. Running nova is currently only supported on
|
||||||
Linux, although you can run the unit tests on Mac OS X. See
|
Linux, although you can run the unit tests on Mac OS X.
|
||||||
:doc:`../quickstart` for how to get a working version of OpenStack
|
|
||||||
Compute running as quickly as possible.
|
|
||||||
|
|
||||||
.. _supported hypervisors: http://wiki.openstack.org/HypervisorSupportMatrix
|
.. _supported hypervisors: http://wiki.openstack.org/HypervisorSupportMatrix
|
||||||
|
|
||||||
Virtual environments
|
Virtual environments
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
Nova development uses `virtualenv <http://pypi.python.org/pypi/virtualenv>`__ to track and manage Python
|
Nova development uses a set of shell scripts in DevStack. Virtual
|
||||||
dependencies while in development and testing. This allows you to
|
enviroments with venv are also available with the source code.
|
||||||
install all of the Python package dependencies in a virtual
|
|
||||||
environment or "virtualenv" (a special subdirectory of your nova
|
|
||||||
directory), instead of installing the packages at the system level.
|
|
||||||
|
|
||||||
.. note::
|
The easiest way to build a fully functional development environment is
|
||||||
|
with DevStack. Create a machine (such as a VM or Vagrant box) running a
|
||||||
|
distribution supported by DevStack and install DevStack there. For
|
||||||
|
example, there is a Vagrant script for DevStack at https://github.com/jogo/DevstackUp.
|
||||||
|
|
||||||
Virtualenv is useful for running the unit tests, but is not
|
.. note::
|
||||||
typically used for full integration testing or production usage.
|
|
||||||
|
If you prefer not to use devstack, you can still check out source code on your local
|
||||||
|
machine and develop from there.
|
||||||
|
|
||||||
Linux Systems
|
Linux Systems
|
||||||
-------------
|
-------------
|
||||||
@ -146,11 +144,10 @@ basis by running::
|
|||||||
Contributing Your Work
|
Contributing Your Work
|
||||||
----------------------
|
----------------------
|
||||||
|
|
||||||
Once your work is complete you may wish to contribute it to the project. Add
|
Once your work is complete you may wish to contribute it to the project.
|
||||||
your name and email address to the ``Authors`` file, and also to the ``.mailmap``
|
Refer to HowToContribute_ for information.
|
||||||
file if you use multiple email addresses. Your contributions can not be merged
|
Nova uses the Gerrit code review system. For information on how to submit
|
||||||
into trunk unless you are listed in the Authors file. Nova uses the Gerrit
|
your branch to Gerrit, see GerritWorkflow_.
|
||||||
code review system. For information on how to submit your branch to Gerrit,
|
|
||||||
see GerritWorkflow_.
|
|
||||||
|
|
||||||
.. _GerritWorkflow: http://wiki.openstack.org/GerritWorkflow
|
.. _GerritWorkflow: http://wiki.openstack.org/GerritWorkflow
|
||||||
|
.. _HowToContribute: http://wiki.openstack.org/HowToContribute
|
||||||
|
Loading…
Reference in New Issue
Block a user