Skip to contentSkip to conversation

upgrade-helper.conf: add a template for easy deployment

PATCH New Alexander Kanavin 1 participant 2 messages Feb 12, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/2 upgrade-helper.conf: add a template for easy deployment

From: Chang Rebecca Swee Fun <[email protected]>

Settings mentioned in the README have been ported over and now users are able to copy and start modifying for personal use cases. This file will served as a reference to minimize errors when users trying to create a new conf file by following the README.

---
 upgrade-helper.conf | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 70 insertions(+)
 create mode 100644 upgrade-helper.conf
upgrade-helper.conf new file +70 -0
new file mode 100644
index 0000000..c9cc150
@@ -0,0 +1,70 @@
+#
+# This file is your upgrade-helper configuration files and is where all local user
+# settings specifically for AUH are placed. The comments in this file provide some
+# guidelines to the options a new user to AUH tool might want to change.
+#
+# This file should be placed inside your BUILDDIR/upgrade-helper after initializing
+# the OE build environment.
+#
+# Lines starting with the '#' character are commented out and in some cases the
+# default values are provided as comments to show people example syntax. Enabling
+# the option is a question of removing the # character and making any change to the
+# variable as required.
+
+[maintainer_override]
+# mails for recipe upgrades will go to john.doe instead of jane.doe, etc
+# see also the global_maintainer_override option
[email protected][email protected]
[email protected][email protected]
+
+[settings]
+# recipes in blacklist will be skipped
+blacklist=python glibc gcc
+
+# only recipes belonging to maintainers in whitelist will be attempted
[email protected] [email protected] [email protected]
+
+# email for all recipe upgrades will go to john.doe, except those listed
+# in specific maintainer_override entries above
[email protected]
+
+# SMTP server
+# Optional if your are running AUH locally
+smtp=smtp.my-server.com:25
+
+# from whom should the mails arrive
[email protected]
+
+# who should get the status mail with statistics, at the end
[email protected]
+
+# specify the directory where work (patches) will be saved (optional)
+#workdir=
+
+# publish url to use in statistics summary (optional)
+#publish_work_url=http://auh.somehost.com/work
+
+# clean sstate directory before upgrading
+clean_sstate=yes
+
+# clean tmp directory before upgrading
+clean_tmp=yes
+
+# Machines to test build with.
+# Append _libc-name to test with alternative C library implementations
+# e.g. qemux86_musl.
+#
+# Buildhistory and testimages will be created only for the first
+# machine in the list, as otherwise it adds enormously to AUH run time.
+machines=qemux86 qemux86_musl qemux86-64 qemuarm qemumips qemuppc
+
+# optional features
+buildhistory=no
+testimage=no
+testimage_name=image-custom # defaults to core-image-sato
+
+# to enable upgrade recipes in a layer example for meta-intel
+layer_mode=False
+layer_name=meta-intel
+layer_dir=DIR/meta-intel
+layer_machines=intel-core2-32 intel-corei7-64 intel-quark
Signature · 1 line
2.15.1
#1 lore raw

PATCH 2/2 Improve README and sample config file.

Specifically, add more information about various config settings, add a few important points to README, and remove config file specifics from README, so that there's only one source for what the settings are (the sample config file).

Also comment out everything from the config file, so that those in a hurry can take it into use immediately. Most settings are specific to a maintainer, and so can't be provided in a 'generic' way.

---
 README              | 83 +++++++++------------------------------------------
 upgrade-helper.conf | 85 +++++++++++++++++++++++++++++++++--------------------
 2 files changed, 67 insertions(+), 101 deletions(-)
README +14 -69
index 4a8181f..4752dc6 100644
@@ -27,67 +27,8 @@ Setup
    undesirable ways.
 
 2. Prepare a configuration file, by default in $BUILDDIR/upgrade-helper/
-   upgrade-helper.conf, as below:
-
---------------- snip ---------------
-[maintainer_override]
-# mails for recipe upgrades will go to john.doe instead of jane.doe, etc
-# see also the global_maintainer_override option
[email protected][email protected]
[email protected][email protected]
-
-[settings]
-# recipes in blacklist will be skipped
-blacklist=python glibc gcc
-
-# only recipes belonging to maintainers in whitelist will be attempted
[email protected] [email protected] [email protected]
-
-# email for all recipe upgrades will go to john.doe, except those listed
-# in specific maintainer_override entries above
[email protected]
-
-# SMTP server
-smtp=smtp.my-server.com:25
-
-# from whom should the mails arrive
[email protected]
-
-# who should get the status mail with statistics, at the end
[email protected]
-
-# specify the directory where work (patches) will be saved (optional)
-#workdir=
-
-# publish url to use in statistics summary (optional)
-#publish_work_url=http://auh.somehost.com/work
-
-# clean sstate directory before upgrading
-clean_sstate=yes
-
-# clean tmp directory before upgrading
-clean_tmp=yes
-
-# Machines to test build with.
-# Append _libc-name to test with alternative C library implementations
-# e.g. qemux86_musl.
-#
-# Buildhistory and testimages will be created only for the first
-# machine in the list, as otherwise it adds enormously to AUH run time.
-machines=qemux86 qemux86_musl qemux86-64 qemuarm qemumips qemuppc
-
-# optional features
-buildhistory=no
-testimage=no
-testimage_name=image-custom # defaults to core-image-sato
-
-# to enable upgrade recipes in a layer example for meta-intel
-layer_mode=False
-layer_name=meta-intel
-layer_dir=DIR/meta-intel
-layer_machines=intel-core2-32 intel-corei7-64 intel-quark
-
---------------- snip ---------------
+   upgrade-helper.conf. A sample file is provided in AUH source tree;
+   it can be used as-is, or tweaked further.
 
 3. Enable distrodata and supply appropriate additional metadata. For
    example, you could add the following to your conf/local.conf:
@@ -99,13 +40,13 @@ INHERIT =+ "distrodata"
 WARNING: if you are using the default maintainers.inc file supplied
          with Poky (in meta-yocto) and you don't set a
          maintainers_whitelist or (global_)maintainer_override in the
-         upgrade-helper configuration as above, and you specify "all"
+         upgrade-helper configuration as above, and you specify "-e all"
          on the command line, the script will automatically send out
          emails to the default maintainers. Please be careful not to
          do this :)
 
-4. If you want to enable buildhistory (optional) you need to enable in
-upgrade-helper.conf also add the following lines to your conf/local.conf
+4. If you want to enable buildhistory (optional) you need to enable it in
+upgrade-helper.conf, and also add the following lines to your conf/local.conf
 file:
 
 --------------- snip ---------------
@@ -135,10 +76,6 @@ a vncserver example:
 $ vncserver :1
 $ export DISPLAY=:1
 
-If upgrade is succesful testimage/ptest results are generated into
-$BUILDDIR/upgrade-helper/work/recipe/ptest_recipe.log if recipe support
-ptest.
-
 (Do not remove any other inherited class in the process, e.g. distrodata).
 
 Usage
@@ -152,10 +89,18 @@ Some manual usage examples:
 * To upgrade the xmodmap recipe to a user specified version:
     $ upgrade-helper.py xmodmap -t 1.2.3
 
+* To upgrade all recipes to latest available versions, without 
+  sending any emails:
+    $ upgrade-helper.py all
+
 * To attempt to upgrade all recipes and automatically send email
   messages to maintainers for each attempted recipe as well as a
   status mail at the end, use:
-    $ upgrade-helper.py all
+    $ upgrade-helper.py -e all
+
+The results of the AUH run (patches, logs and any other relevant information)
+are then found in ${BUILDDIR}/upgrade-helper/<timestamp>. AUH will also
+create recipe update commits from successful upgrade attempts in the layer tree.
 
 If you wish to run the script on a regular basis, you can set up a cron
 job; the "weeklyjob.sh" file distributed with this project is the basis
upgrade-helper.conf +53 -32

118 lines not on this page · raw message

Signature · 1 line
2.15.1