From a88a768e9806c118af4fd49d8aeb56aa99c674b7 Mon Sep 17 00:00:00 2001 From: Ian Wienand Date: Wed, 9 Aug 2017 13:12:13 +1000 Subject: [PATCH] Clear up debian element documentation 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 --- diskimage_builder/elements/debian-minimal/README.rst | 3 +-- diskimage_builder/elements/debian/README.rst | 4 ++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/diskimage_builder/elements/debian-minimal/README.rst b/diskimage_builder/elements/debian-minimal/README.rst index f7bd9eb8..aaea5d2e 100644 --- a/diskimage_builder/elements/debian-minimal/README.rst +++ b/diskimage_builder/elements/debian-minimal/README.rst @@ -3,8 +3,7 @@ debian-minimal ============== The ``debian-minimal`` element uses debootstrap for generating a -minimal image. In contrast the ``debian`` element uses the cloud-image -as the initial base. +minimal image. By default this element creates the latest stable release. The exact setting can be found in the element's ``environment.d`` directory in diff --git a/diskimage_builder/elements/debian/README.rst b/diskimage_builder/elements/debian/README.rst index 3343d84e..11b0c002 100644 --- a/diskimage_builder/elements/debian/README.rst +++ b/diskimage_builder/elements/debian/README.rst @@ -2,6 +2,10 @@ 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 setting can be found in the ``debian-minimal/environment.d`` directory in the variable ``DIB_RELEASE``. If a different release of Debian