openstack
/
diskimage-builder
Code Issues Proposed changes

Merge "Document what our stable interfaces are"

This commit is contained in:
Jenkins 2015-07-23 14:18:00 +00:00 committed by Gerrit Code Review
parent dc197197a2 c922640d3f
commit 2a0b32418b
2 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/developer/index.rst
View File

@ -10,3 +10,4 @@ Developer Documentation
caches
install_types
developing_elements
stable_interfaces

19
doc/source/developer/stable_interfaces.rst Normal file
View File

@ -0,0 +1,19 @@
Stable Interfaces
=================
diskimage-builder and the elements provide several 'stable' interfaces for both
developers and users which we aim to preserve during a major version release.
These interfaces consist of:
The names and arguments of the executable scripts included with
diskimage-builder in the bin directory will remain stable.
The environment variables that diskimage-builder provides for elements to use
will remain stable.
The environment variables documented in each element and the values accepted
by these environment variables will remain stable.
Required environment variables for an element will not be added.
Support for build or target distributions will not be removed.