openstack/diskimage-builder
Code Issues Proposed changes

Update apt-preferences element README from free text to table formatting

Browse Source 
Change-Id: Iae04b809c8008487fabe1a173123928ab157c78d
This commit is contained in:
Augustina Ragwitz 2015-10-07 13:32:30 -07:00
parent ea94034331
commit b1958bfbbe
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
elements/apt-preferences/README.rst
View File

@ -2,10 +2,20 @@
apt-preferences apt-preferences
=============== ===============
This element creates package pins for apt systems if packages need to be held This element generates the APT preferences file based on the provided manifest
back. provided by the :doc:`../manifests/README` element.
For APT based systems, you specify package priorities in the apt preferences file. The APT preferences file can be used to control which versions of packages will
This element reads the given manifest file, specified in `DIB_DPKG_MANIFEST`, to be selected for installation. APT uses a priority system to make this
set pins to enable pinning of older versions for the given packages. determination. For more information about APT preferences, see the apt_preferences(5)
man page.
Environment Variables
---------------------
DIB_DPKG_MANIFEST:
:Required: No
:Default: None
:Description: The manifest file to generate the APT preferences file from.
:Example: ``DIB\_DPKG\_MANIFEST=~/image.d/dib-manifests/dib-manifest-dpkg-image``