sig_cloud/diskimage-builder
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document what our stable interfaces are

Browse Source 
Before we do a 1.0 release, we should really document what we are
commiting to.

Change-Id: I44c62f9b1a35ace5dc7d963ab5bddc83fba4bce3
This commit is contained in:
Gregory Haynes 2015-07-06 16:52:36 +00:00
parent 96c134b429
commit c922640d3f
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.