[yocto] [PATCH][auh 2/2] Improve README and sample config file.
Alexander Kanavin
alexander.kanavin at linux.intel.com
Mon Feb 12 07:40:51 PST 2018
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.
Signed-off-by: Alexander Kanavin <alexander.kanavin at linux.intel.com>
---
README | 83 +++++++++------------------------------------------
upgrade-helper.conf | 85 +++++++++++++++++++++++++++++++++--------------------
2 files changed, 67 insertions(+), 101 deletions(-)
diff --git a/README b/README
index 4a8181f..4752dc6 100644
--- a/README
+++ b/README
@@ -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
-jane.doe at doe.com=john.doe at doe.com
-johhny.bravo at bravo.com=john.doe at doe.com
-
-[settings]
-# recipes in blacklist will be skipped
-blacklist=python glibc gcc
-
-# only recipes belonging to maintainers in whitelist will be attempted
-maintainers_whitelist=jane.doe at doe.com john.doe at doe.com johhny.bravo at bravo.com
-
-# email for all recipe upgrades will go to john.doe, except those listed
-# in specific maintainer_override entries above
-global_maintainer_override=john.doe at doe.com
-
-# SMTP server
-smtp=smtp.my-server.com:25
-
-# from whom should the mails arrive
-from=upgrade.helper at my-server.com
-
-# who should get the status mail with statistics, at the end
-status_recipients=john.doe at doe.com
-
-# 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
diff --git a/upgrade-helper.conf b/upgrade-helper.conf
index c9cc150..b84b407 100644
--- a/upgrade-helper.conf
+++ b/upgrade-helper.conf
@@ -4,7 +4,7 @@
# 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.
+# the OE build environment (this location can be overriden with -c command line option).
#
# 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
@@ -12,43 +12,51 @@
# variable as required.
[maintainer_override]
-# mails for recipe upgrades will go to john.doe instead of jane.doe, etc
+# e-mail message for recipe upgrades will go to john.doe instead of jane.doe, etc
# see also the global_maintainer_override option
-jane.doe at doe.com=john.doe at doe.com
-johhny.bravo at bravo.com=john.doe at doe.com
+#jane.doe at doe.com=john.doe at doe.com
+#johhny.bravo at bravo.com=john.doe at doe.com
[settings]
-# recipes in blacklist will be skipped
-blacklist=python glibc gcc
+# SMTP server that is used to send e-mails with patches and other information.
+# If you are running AUH locally, you do not need to set this up, as AUH
+# saves everything to BUILDDIR/upgrade-helper/<timestamp>, and does not attempt
+# to send email messages (unless explicitly asked with -e command line option).
+#smtp=smtp.my-server.com:25
-# only recipes belonging to maintainers in whitelist will be attempted
-maintainers_whitelist=jane.doe at doe.com john.doe at doe.com johhny.bravo at bravo.com
+# from whom should the e-mails be sent.
+#from=upgrade.helper at my-server.com
-# email for all recipe upgrades will go to john.doe, except those listed
-# in specific maintainer_override entries above
-global_maintainer_override=john.doe at doe.com
+# If enabled, emails for all recipe upgrades will go to john.doe,
+# except when recipes are owned by specific maintainer_override entries above.
+#global_maintainer_override=john.doe at doe.com
-# SMTP server
-# Optional if your are running AUH locally
-smtp=smtp.my-server.com:25
+# who should get the status mail with statistics, at the end (optional)
+#status_recipients=john.doe at doe.com
-# from whom should the mails arrive
-from=upgrade.helper at my-server.com
+# Only recipes belonging to maintainers in whitelist will be attempted
+# Insert your own e-mail address here together with any other maintainers' addresses
+# whose recipes you wish to take care of. This restricts the set of recipes that AUH
+# will attempt when it is run with 'all' option.
+#maintainers_whitelist=jane.doe at doe.com john.doe at doe.com johhny.bravo at bravo.com
-# who should get the status mail with statistics, at the end
-status_recipients=john.doe at doe.com
+# recipes in blacklist will be skipped
+#blacklist=python glibc gcc
-# specify the directory where work (patches) will be saved (optional)
+# specify the directory where work (patches) will be saved
+# (optional; default is BUILDDIR/upgrade-helper/)
#workdir=
-# publish url to use in statistics summary (optional)
+# public url with AUH results to include in statistics summary (optional)
#publish_work_url=http://auh.somehost.com/work
# clean sstate directory before upgrading
-clean_sstate=yes
+# Generally not necessary, as bitbake can handle this automatically.
+#clean_sstate=yes
# clean tmp directory before upgrading
-clean_tmp=yes
+# Generally not necessary as bitbake can handle this automatically.
+#clean_tmp=yes
# Machines to test build with.
# Append _libc-name to test with alternative C library implementations
@@ -56,15 +64,28 @@ clean_tmp=yes
#
# 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
+#
+# AUH has a reasonable default for this, so you do not need to set your own,
+# at least initially.
+#
+#machines=qemux86 qemux86_musl qemux86-64 qemuarm qemumips qemuppc
-# optional features
-buildhistory=no
-testimage=no
-testimage_name=image-custom # defaults to core-image-sato
+# Enables buildhistory feature; this is useful as it produces information
+# about what has changed in the resulting packages, compared to previous version
+#buildhistory=yes
-# 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
+# If enabled, build and boots a test image, and runs integration tests on it
+# If upgraded packages have ptest support those are run as well
+#testimage=no
+#
+# This can be used to change the name of the test image.
+#
+#testimage_name=image-custom # defaults to core-image-sato
+
+# This can be used to upgrade recipes in a specific layer,
+# for example meta-intel, instead of upgrading oe-core recipes.
+#
+#layer_mode=False
+#layer_name=meta-intel
+#layer_dir=DIR/meta-intel
+#layer_machines=intel-core2-32 intel-corei7-64 intel-quark
--
2.15.1
More information about the yocto
mailing list