sig_cloud/diskimage-builder
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
950ad3324d
diskimage-builder/diskimage_builder/elements/debian/README.rst

16 lines
485 B
ReStructuredText
Raw Normal View History

Create docs site containing element READMEs We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b
2015-02-07 10:30:02 +00:00
======
debian
======
Use sphinx warning-is-error Sphix 1.5 (I9e7261c4124b71eeb6bddd9e21747b61bbdc16fa) includes "warning-is-error" which supersedes pbr's warnerrors. Enable this and fix up the resulting failures - trailing lines for lists in element_deps directive - missing README's that are linked - syntax error and highlighting in building instructions Change-Id: I6549551b4a9bf47076c9811a7a38a666cbea2a50
2017-03-14 00:33:01 +00:00
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
2017-08-09 03:12:13 +00:00
This element is based on ``debian-minimal`` with ``cloud-init`` and
related tools installed. This produces something more like a standard
upstream cloud image.
Unify and fix doc of several Debian and Ubuntu elements This patch removes three nearly-copies of debootstrap documentation and fixes some documentation aspects. Change-Id: Ief7794f5c1abad73788c063af6c862472cd34744 Signed-off-by: Andreas Florath <andreas@florath.net>
2017-01-17 19:59:16 +00:00
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
should be created, the variable ``DIB_RELEASE`` can be set
appropriately.
Semi-automatic doc generation of element dependency Currently there is no description of dependencies in the generated documentation of the elements: therefore a user of an element does not know which other elements are automatically included and e.g. which configuration options are available. In addition there are some copy&pastes of parts of the README.rst scattered thought different Ubuntu and Debian specific elements. This patch adds a semi-automatic generation of dependency information of all elements. Nevertheless these are not automatically included. The author of the element's README.rst can decide if and where the dependency information should appear and can use the descriptor .. element_deps:: for this. This patch adds the dependency information for some Debian and Ubuntu patches - and creates the base for later removing the duplicated parts. A call is added to element_dependencies._find_all_elements() to populate reverse dependencies for Element objects. (This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for the feature/v2 branch) Change-Id: Iebb83916fed71565071246baa550849eef40560b
2017-01-19 21:00:21 +00:00
.. element_deps::
Reference in New Issue Copy Permalink