openstack/diskimage-builder
Code Issues Proposed changes

Clear up debian element documentation

Browse Source 
There is some confusion in the readme's over what is happening.  The
original change (Iaf46c8e61bf1cac9a096cbfd75d6d6a9111b701e) split out
debian-minimal and made debian "... simply be a collection of the
extra things we do to make it look like a cloud-init based cloud
image"

Make this clearer in the documentation

Change-Id: Ibe6fad9c67b70a5e31e43e06419968135174fef3
This commit is contained in:
Ian Wienand 2017-08-09 13:12:13 +10:00
parent e04cf78fa5
commit a88a768e98
2 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
diskimage_builder/elements/debian-minimal/README.rst
View File

@ -3,8 +3,7 @@ debian-minimal
============== ==============
The ``debian-minimal`` element uses debootstrap for generating a The ``debian-minimal`` element uses debootstrap for generating a
minimal image. In contrast the ``debian`` element uses the cloud-image minimal image.
as the initial base.
By default this element creates the latest stable release. The exact By default this element creates the latest stable release. The exact
setting can be found in the element's ``environment.d`` directory in setting can be found in the element's ``environment.d`` directory in

4
diskimage_builder/elements/debian/README.rst
View File

@ -2,6 +2,10 @@
debian debian
====== ======
This element is based on ``debian-minimal`` with ``cloud-init`` and
related tools installed. This produces something more like a standard
upstream cloud image.
By default this element creates the latest stable release. The exact By default this element creates the latest stable release. The exact
setting can be found in the ``debian-minimal/environment.d`` directory setting can be found in the ``debian-minimal/environment.d`` directory
in the variable ``DIB_RELEASE``. If a different release of Debian in the variable ``DIB_RELEASE``. If a different release of Debian