Document what our stable interfaces are
Before we do a 1.0 release, we should really document what we are commiting to. Change-Id: I44c62f9b1a35ace5dc7d963ab5bddc83fba4bce3
This commit is contained in:
parent
96c134b429
commit
c922640d3f
@ -10,3 +10,4 @@ Developer Documentation
|
||||
caches
|
||||
install_types
|
||||
developing_elements
|
||||
stable_interfaces
|
||||
|
19
doc/source/developer/stable_interfaces.rst
Normal file
19
doc/source/developer/stable_interfaces.rst
Normal 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.
|
Loading…
Reference in New Issue
Block a user