openstack/diskimage-builder
Code Issues Proposed changes

Prettify 'Caches and offline mode' documentation

Browse Source 
Use inline code syntax for env variables.
Link to elements README files.
Point 'redhat' to 'redhat-common' instead.

Change-Id: Ied1150aaa631c7c6d7f2f55314f9aa3529fd4ba0
This commit is contained in:
Antoine Musso 2015-09-17 12:14:24 +02:00
parent e8cecab45c
commit bcce4842cf
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/developer/caches.rst
View File

@ -5,11 +5,12 @@ Since retrieving and transforming operating system image files, git
repositories, Python or Ruby packages, and so on can be a significant overhead, repositories, Python or Ruby packages, and so on can be a significant overhead,
we cache many of the inputs to the build process. we cache many of the inputs to the build process.
The cache location is read from DIB\_IMAGE\_CACHE. :ref:`developing-elements` The cache location is read from ``DIB_IMAGE_CACHE``. :ref:`developing-elements`
describes the interface within disk-image-builder for caching. describes the interface within disk-image-builder for caching.
When invoking disk-image-builder, the ``--offline`` option will instruct When invoking disk-image-builder, the ``--offline`` option will instruct
disk-image-builder to not refresh cached resources. disk-image-builder to not refresh cached resources. Alternatively you can set
``DIB_OFFLINE=1``.
Note that we don't maintain operating system package caches, instead depending Note that we don't maintain operating system package caches, instead depending
on your local infrastructure (e.g. Squid cache, or an APT or Yum proxy) to on your local infrastructure (e.g. Squid cache, or an APT or Yum proxy) to
@ -21,23 +22,24 @@ offline mode. For more information about setting up a squid proxy, consult the
Base images Base images
----------- -----------
These are cached by the standard elements - fedora, redhat, ubuntu, These are cached by the standard elements - :doc:`../elements/fedora/README`,
debian and opensuse. :doc:`../elements/redhat-common/README`, :doc:`../elements/ubuntu/README`,
:doc:`../elements/debian/README` and :doc:`../elements/opensuse/README`.
source-repositories source-repositories
------------------- -------------------
Git repositories and tarballs obtained via the source-repositories element will Git repositories and tarballs obtained via the
be cached. :doc:`../elements/source-repositories/README` element will be cached.
C and C++ compilation C and C++ compilation
--------------------- ---------------------
Ccache is configured by the base element. Any compilation that honours ccache Ccache is configured by the :doc:`../elements/base/README` element. Any
will be cached. compilation that honours ccache will be cached.
PyPI PyPI
---- ----
The pypi element will bind mount a PyPI mirror from the cache dir and configure The :doc:`../elements/pypi/README` element will bind mount a PyPI mirror from
pip and easy-install to use it. the cache dir and configure pip and easy-install to use it.