ab5ed610e4
As described in the comments, inspect the installation to see if we have been installed with "pip -e" and, if so, make sure we reference the scripts from the source location rather than the system-installations. Update the documentation with a terse but helpful quick-start to show an easy way to start developing a change using this. Closes-Bug: #1491035 Change-Id: I0460061b834a2b854175f8c9be2be8d38c540c9d
32 lines
669 B
ReStructuredText
32 lines
669 B
ReStructuredText
Developer Documentation
|
|
=======================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
design
|
|
components
|
|
invocation
|
|
caches
|
|
install_types
|
|
developing_elements
|
|
stable_interfaces
|
|
|
|
Quickstart
|
|
----------
|
|
|
|
To get started developing with ``diskimage-builder``, install to a
|
|
``virtualenv``::
|
|
|
|
$ mkdir dib
|
|
$ cd dib
|
|
$ virtualenv create env
|
|
$ source env/bin/activate
|
|
$ git clone https://git.openstack.org/openstack/diskimage-builder
|
|
$ cd diskimage-builder
|
|
$ pip install -e .
|
|
|
|
You can now simply use ``disk-image-create`` to start building images
|
|
and testing your changes. When you are done editing, use ``git
|
|
review`` to submit changes to the upstream gerrit.
|