From b3c448e765780cb67f7b68b59bf6ea7ff81e54ac Mon Sep 17 00:00:00 2001 From: Augustina Ragwitz Date: Tue, 6 Oct 2015 17:27:33 -0700 Subject: [PATCH] Update apt-conf elements README from free text to table formatting Change-Id: Ie89ce94fd063e04d57158a2e0faf11719537d450 --- elements/apt-conf/README.rst | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/elements/apt-conf/README.rst b/elements/apt-conf/README.rst index e411f829..697b5daa 100644 --- a/elements/apt-conf/README.rst +++ b/elements/apt-conf/README.rst @@ -2,20 +2,15 @@ apt-conf ======== -This element overrides the default apt.conf. +This element overrides the default apt.conf for APT based systems. -For APT based systems, if you require specific options for apt operations, -you can define `DIB_APT_CONF` with your favorite apt.conf to override it, -before running devtest.sh. +Environment Variables +--------------------- -The new apt.conf will take effect at build time and run time. - -If you want to use this element with tripleo-incubator scripts, set `NODE_DIST` -/ `SEED_DIB_EXTRA_ARGS` / `UNDERCLOUD_DIB_EXTRA_ARGS` / -`OVERCLOUD_CONTROL_DIB_EXTRA_ARGS` / `OVERCLOUD_COMPUTE_DIB_EXTRA_ARGS` to -make it take effect at the appropriate time. - -For instance, before running devtest.sh: - - export DIB_APT_CONF=/etc/apt/apt.conf - export NODE_DIST="ubuntu apt-conf" +DIB_APT_CONF: + :Required: No + :Default: None + :Description: To override `DIB_APT_CONF`, set it to the path to your + apt.conf. The new apt.conf will take effect at build time and + run time. + :Example: ``DIB_APT_CONF=/etc/apt/apt.conf``