[libvirt PATCH] ci: Makefile: Mention CI_MAKE_ARGS and CI_CONFIGURE_ARGS in ci-help

Erik Skultety posted 1 patch 3 years, 10 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/12e73ab4438a0a179cdde9232f8a5315ff0f29b1.1592403451.git.eskultet@redhat.com
ci/Makefile | 2 ++
1 file changed, 2 insertions(+)
[libvirt PATCH] ci: Makefile: Mention CI_MAKE_ARGS and CI_CONFIGURE_ARGS in ci-help
Posted by Erik Skultety 3 years, 10 months ago
Document the CI_MAKE_ARGS and CI_CONFIGURE_ARGS so that users don't have
to skim through the Makefile to be able to pass arbitrary recognized
make targets to the build system.

Signed-off-by: Erik Skultety <eskultet@redhat.com>
---
 ci/Makefile | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/ci/Makefile b/ci/Makefile
index 7840cc8d89..df60e6bf3c 100644
--- a/ci/Makefile
+++ b/ci/Makefile
@@ -266,4 +266,6 @@ ci-help:
 	@echo "    CI_CLEAN=0     - do not delete '$(CI_SCRATCHDIR)' after completion"
 	@echo "    CI_REUSE=1     - re-use existing '$(CI_SCRATCHDIR)' content"
 	@echo "    CI_ENGINE=auto - container engine to use (podman, docker)"
+	@echo "    CI_CONFIGURE_ARGS=  - extra arguments passed to configure"
+	@echo "    CI_MAKE_ARGS=  - extra arguments passed to make, e.g. space delimited list of make targets"
 	@echo
-- 
2.26.2

Re: [libvirt PATCH] ci: Makefile: Mention CI_MAKE_ARGS and CI_CONFIGURE_ARGS in ci-help
Posted by Andrea Bolognani 3 years, 10 months ago
On Wed, 2020-06-17 at 16:17 +0200, Erik Skultety wrote:
> +++ b/ci/Makefile
> @@ -266,4 +266,6 @@ ci-help:
>  	@echo "    CI_CLEAN=0     - do not delete '$(CI_SCRATCHDIR)' after completion"
>  	@echo "    CI_REUSE=1     - re-use existing '$(CI_SCRATCHDIR)' content"
>  	@echo "    CI_ENGINE=auto - container engine to use (podman, docker)"
> +	@echo "    CI_CONFIGURE_ARGS=  - extra arguments passed to configure"
> +	@echo "    CI_MAKE_ARGS=  - extra arguments passed to make, e.g. space delimited list of make targets"

Please re-align existing entries, and consider

  s/make targets/targets/

With the whitespace changes,

  Signed-off-by: Andrea Bolognani <abologna@redhat.com>

-- 
Andrea Bolognani / Red Hat / Virtualization

Re: [libvirt PATCH] ci: Makefile: Mention CI_MAKE_ARGS and CI_CONFIGURE_ARGS in ci-help
Posted by Erik Skultety 3 years, 10 months ago
On Wed, Jun 17, 2020 at 04:56:28PM +0200, Andrea Bolognani wrote:
> On Wed, 2020-06-17 at 16:17 +0200, Erik Skultety wrote:
> > +++ b/ci/Makefile
> > @@ -266,4 +266,6 @@ ci-help:
> >  	@echo "    CI_CLEAN=0     - do not delete '$(CI_SCRATCHDIR)' after completion"
> >  	@echo "    CI_REUSE=1     - re-use existing '$(CI_SCRATCHDIR)' content"
> >  	@echo "    CI_ENGINE=auto - container engine to use (podman, docker)"
> > +	@echo "    CI_CONFIGURE_ARGS=  - extra arguments passed to configure"
> > +	@echo "    CI_MAKE_ARGS=  - extra arguments passed to make, e.g. space delimited list of make targets"
>
> Please re-align existing entries, and consider

I can do that, but I think we should just use a single space (or 2) in between
the variable and the description, so that when we add something longer than
CI_CONFIGURE_ARGS we don't have to re-align again, there's no point in that.

Re: [libvirt PATCH] ci: Makefile: Mention CI_MAKE_ARGS and CI_CONFIGURE_ARGS in ci-help
Posted by Andrea Bolognani 3 years, 10 months ago
On Wed, 2020-06-17 at 17:27 +0200, Erik Skultety wrote:
> On Wed, Jun 17, 2020 at 04:56:28PM +0200, Andrea Bolognani wrote:
> > On Wed, 2020-06-17 at 16:17 +0200, Erik Skultety wrote:
> > > +++ b/ci/Makefile
> > > @@ -266,4 +266,6 @@ ci-help:
> > >  	@echo "    CI_CLEAN=0     - do not delete '$(CI_SCRATCHDIR)' after completion"
> > >  	@echo "    CI_REUSE=1     - re-use existing '$(CI_SCRATCHDIR)' content"
> > >  	@echo "    CI_ENGINE=auto - container engine to use (podman, docker)"
> > > +	@echo "    CI_CONFIGURE_ARGS=  - extra arguments passed to configure"
> > > +	@echo "    CI_MAKE_ARGS=  - extra arguments passed to make, e.g. space delimited list of make targets"
> > 
> > Please re-align existing entries, and consider
> 
> I can do that, but I think we should just use a single space (or 2) in between
> the variable and the description, so that when we add something longer than
> CI_CONFIGURE_ARGS we don't have to re-align again, there's no point in that.

I would really not worry about churn in this case: it's not a C
struct, which we change all the time, and moreover since it's a
user-visible string IMHO it makes sense to spend a little more
effort to make it prettier and more readable at a glance.

But, if you prefer to keep it like this, that's fine too and my
R-b still stands :)

-- 
Andrea Bolognani / Red Hat / Virtualization