Add section zero for point that needs Yocto dependencies also git configured.
Add description about the buildhistory output if upgrade succeed. Remove mode usage for upgrade two recipes in automatic now is deprecated the available modes are automatic for all recipes and manual for one. [YOCTO #7439] Signed-off-by: Aníbal Limón <[email protected]> --- README | 33 ++++++++++++++++++++------------- 1 file changed, 20 insertions(+), 13 deletions(-) diff --git a/README b/README index dbcc755..44c3bf1 100644 --- a/README +++ b/README @@ -10,13 +10,20 @@ published upstream. Setup ----- +0. AUH needs all the dependencies listed for Yocto also requires git + configured because uses it to save upgrades, you need to have git + user and email configured, example: + + $ git config --global user.name "Some Name" + $ git config --global user.email "[email protected]" + 1. Ensure you have a working copy of the build system that is configured and ready to run, i.e. you've run the oe-init-build-env script to create a build directory and edited local.conf / bblayers.conf as desired. -2. Prepare a configuration file, by default in $BUILDDIR/upgrade-helper, - as below: +2. Prepare a configuration file, by default in $BUILDDIR/upgrade-helper/ + upgrade-helper.conf, as below: --------------- snip --------------- [maintainer_override] @@ -27,20 +34,28 @@ [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] + # 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] + # clean sstate directory before upgrading clean_sstate=yes + # clean tmp directory before upgrading clean_tmp=yes + # keep previous commits or not drop_previous_commits=yes + # machines to test build with machines=qemux86 qemux86-64 qemuarm qemumips qemuppc --------------- snip --------------- @@ -50,10 +65,6 @@ machines=qemux86 qemux86-64 qemuarm qemumips qemuppc --------------- snip --------------- INHERIT =+ "distrodata" -require conf/distro/include/recipe_color.inc -require conf/distro/include/distro_alias.inc -require conf/distro/include/maintainers.inc -require conf/distro/include/upstream_tracking.inc --------------- snip --------------- WARNING: if you are using the default maintainers.inc file supplied @@ -72,8 +83,10 @@ INHERIT =+ "buildhistory" BUILDHISTORY_COMMIT" = "1" --------------- snip --------------- -(Do not remove any other inherited class in the process, e.g. distrodata). +If upgrade is succesful buildhistory diff's are generated into +$BUILDDIR/upgrade-helper/work/recipe/buildhistory-diff.txt. +(Do not remove any other inherited class in the process, e.g. distrodata). Usage ----- @@ -88,9 +101,6 @@ Some manual usage examples: interactively: $ upgrade-helper.py xmodmap -t 1.2.3 -* To upgrade a list of recipes in automatic mode: - $ upgrade-helper.py -a xmodmap xf86-video-intel - * 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: @@ -101,7 +111,6 @@ job; the "weeklyjob.sh" file distributed with this project is the basis of a script you can call from a cron job and also provides an example crontab line. - Maintenance ----------- @@ -115,11 +124,9 @@ Contributions are welcome. Please send patches / pull requests to [email protected] with '[auh]' in the subject also CC the current maintainer: Aníbal Limón <[email protected]>. - License ------- This application is licensed under the GNU General Public License version 2.0 or (at your option) any later version. Please see the LICENSE file for further details. - -- 1.9.1 -- _______________________________________________ yocto mailing list [email protected] https://lists.yoctoproject.org/listinfo/yocto
