[yocto] [RFC] [auh] [PATCH] upgrade-helper.conf: add a template for easy deployment

[Alexander Kanavin]

On 02/09/2018 07:43 AM, Chang Rebecca Swee Fun wrote:
> 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.

Thanks, something like this is definitely useful and we should have it. 
It could use a bit of further tweaking though, particularly better 
commentary. Also, the corresponding part in README can be removed at the 
same time.

> +[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
> +# Optional if your are running AUH locally
> +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

The default use case is someone who runs AUH on his local machine. So 
all of the above should be commented out, except maintainers_whitelist 
perhaps (we should explain that maintainers should put themselves into 
that setting). And an explanation that the results of AUH work are
1) saved as commits
2) saved on disk in the auh workdir (and will not be overwritten, as 
they're time-stamped).


> +# specify the directory where work (patches) will be saved (optional)
> +#workdir=

This needs an explanation for where the default is. The patches are 
saved regardless of whether or not this is set.

> +# 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

This should have better explanations. Also, clean_ things are optional 
and I'm not sure right now what they're for.

> +# 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

Can be commented out, with an explanation of what the auh internal 
default list is.

> +# optional features
> +buildhistory=no
> +testimage=no
> +testimage_name=image-custom # defaults to core-image-sato

This does need to be explained in detail.

> +# 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

Again, lacking explanations.

Alex