diff --git a/doc/source/developer/index.rst b/doc/source/developer/index.rst index 29f26f321..8df2c8769 100644 --- a/doc/source/developer/index.rst +++ b/doc/source/developer/index.rst @@ -10,3 +10,4 @@ Developer Documentation caches install_types developing_elements + stable_interfaces diff --git a/doc/source/developer/stable_interfaces.rst b/doc/source/developer/stable_interfaces.rst new file mode 100644 index 000000000..93609f7e3 --- /dev/null +++ b/doc/source/developer/stable_interfaces.rst @@ -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.