Re: [PATCH 07/10] docs/devel: update and clarify lcitool instructions

[Daniel P . Berrangé]

On Wed, Feb 22, 2023 at 03:37:49PM +0100, Paolo Bonzini wrote:
> Shorten a bit the description of what libvirt-ci does, the name of the
> data files is not relevant at that point.  However, the procedures to add
> new build prerequisites are lacking some information, particularly with
> respect to regenerating the output test files for lcitool's unit tests.
> While at it, also update the paths in the libvirt-ci repository.
> 
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  docs/devel/testing.rst | 72 ++++++++++++++++++++++++------------------
>  1 file changed, 41 insertions(+), 31 deletions(-)
> 
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index e10c47b5a7ca..648b7aa09137 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst

>  
> -In some cases ``libvirt-ci`` will not know about the build pre-requisite and
> -thus some extra preparation steps will be required first
> +In some cases ``libvirt-ci`` will not know about the build
> +pre-requisite and thus some extra preparation steps will be required
> +first.  Even though you can add the mappings for testing purposes to
> +``tests/lcitool/mappings.yml`` in the QEMU repository, please contribute
> +the mapping to the ``libvirt-ci`` project as well:

I'd have a mild preference for not mentioning the qemu local
tests/lcitool/mappings.yml here, as that's for special purpose
use and thus not relevant the majority if the time. I worry
this might mislead people into including changes in the
local tests/lcitool/mappings.yml file, instead of, or in
addition to the libvirt-ci.git submodule.

None the less, its a minor concern so

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


>  
>   * Fork the ``libvirt-ci`` project on gitlab
>  
> - * Edit the ``mappings.yml`` change to add an entry for the new build
> -   prerequisite, listing its native package name on as many OS distros
> -   as practical.
> + * Add an entry for the new build prerequisite to
> +   ``lcitool/facts/mappings.yml``, listing its native package name on as
> +   many OS distros as practical.  Run ``python -m pytest 
> --regenerate-output``


With regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|