* [PATCH] Better highlight 'make distcheck-fast'
@ 2021-12-09 12:07 Thomas Schwinge
2021-12-09 12:13 ` Matthias Maennich
0 siblings, 1 reply; 6+ messages in thread
From: Thomas Schwinge @ 2021-12-09 12:07 UTC (permalink / raw)
To: libabigail; +Cc: Thomas Schwinge
... for the reasons stated.
* CONTRIBUTING: Better highlight 'make distcheck-fast'.
Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
---
CONTRIBUTING | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git CONTRIBUTING CONTRIBUTING
index 7e3e8561..4e70d381 100644
--- CONTRIBUTING
+++ CONTRIBUTING
@@ -63,25 +63,27 @@ is important, because that is how we do to actually release the
tarball of the project that you can download from the internet) then
you can do:
- make distcheck
+ make distcheck-fast
This actually builds the tarball, then untars it, configure/compile
the untarred source code and launches the regression checks from
there.
+Here, "make distcheck-fast" is a variant of the standard "make distcheck".
+It compresses with "--fast" instead of default "--best", and is
+significantly faster, given the size of the distribution. You very likely
+want to use that one for local regression testing.
+
You can also launch this in parallel by doing:
- make -jN -lN distcheck
+ make -jN -lN distcheck-fast
with N being the number of processor core you have on your system.
-Please make sure you always launch "make distcheck" before sending a
+Please make sure you always launch "make distcheck-fast" before sending a
patch, so that you are sure that we can always build a tarball after
your patch is applied to the source tree.
-A variant of distcheck is "make distcheck-fast". It's like "make
-distcheck" but it's faster. You can just use that one.
-
A complementary regression checking target is "check-self-compare".
You invoke it by doing "make check-self-compare". That target
analyzes the ABI of the libabigail.so shared object, serializes it
@@ -89,11 +91,11 @@ into the ABIXML format and then compares the ABI internal
representation gathered from the libabigail.so binary against the one
gathered from the ABIXML format. The two should be equal if
everything goes right. This is an important regression test. The
-problem is that it can takes twice as much time as make distcheck. So
-we've put it into its own separate target.
+problem is that it can takes twice as much time as "make distcheck-fast".
+So we've put it into its own separate target.
So, to be complete the regression checking command to run against your
-patch should be: "make check-self-compare distcheck -j16", if you have
+patch should be: "make check-self-compare distcheck-fast -j16", if you have
a machine with a 16 threads processors, for instance.
Coding language and style
--
2.25.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Better highlight 'make distcheck-fast'
2021-12-09 12:07 [PATCH] Better highlight 'make distcheck-fast' Thomas Schwinge
@ 2021-12-09 12:13 ` Matthias Maennich
2021-12-09 21:38 ` Thomas Schwinge
0 siblings, 1 reply; 6+ messages in thread
From: Matthias Maennich @ 2021-12-09 12:13 UTC (permalink / raw)
To: Thomas Schwinge; +Cc: libabigail
On Thu, Dec 09, 2021 at 01:07:01PM +0100, Thomas Schwinge wrote:
>... for the reasons stated.
>
> * CONTRIBUTING: Better highlight 'make distcheck-fast'.
>
>Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
>---
Thanks! That makes totally sense. :-)
> CONTRIBUTING | 20 +++++++++++---------
> 1 file changed, 11 insertions(+), 9 deletions(-)
>
>diff --git CONTRIBUTING CONTRIBUTING
>index 7e3e8561..4e70d381 100644
>--- CONTRIBUTING
>+++ CONTRIBUTING
>@@ -63,25 +63,27 @@ is important, because that is how we do to actually release the
> tarball of the project that you can download from the internet) then
> you can do:
>
>- make distcheck
>+ make distcheck-fast
>
> This actually builds the tarball, then untars it, configure/compile
> the untarred source code and launches the regression checks from
> there.
>
>+Here, "make distcheck-fast" is a variant of the standard "make distcheck".
>+It compresses with "--fast" instead of default "--best", and is
>+significantly faster, given the size of the distribution. You very likely
>+want to use that one for local regression testing.
>+
> You can also launch this in parallel by doing:
>
>- make -jN -lN distcheck
>+ make -jN -lN distcheck-fast
>
> with N being the number of processor core you have on your system.
>
>-Please make sure you always launch "make distcheck" before sending a
>+Please make sure you always launch "make distcheck-fast" before sending a
> patch, so that you are sure that we can always build a tarball after
> your patch is applied to the source tree.
>
>-A variant of distcheck is "make distcheck-fast". It's like "make
>-distcheck" but it's faster. You can just use that one.
>-
Instead mention that `make distcheck-fast` is not supposed to be used to
create artifacts for distribution, because it creates _different_
results.
> A complementary regression checking target is "check-self-compare".
> You invoke it by doing "make check-self-compare". That target
> analyzes the ABI of the libabigail.so shared object, serializes it
>@@ -89,11 +91,11 @@ into the ABIXML format and then compares the ABI internal
> representation gathered from the libabigail.so binary against the one
> gathered from the ABIXML format. The two should be equal if
> everything goes right. This is an important regression test. The
>-problem is that it can takes twice as much time as make distcheck. So
>-we've put it into its own separate target.
>+problem is that it can takes twice as much time as "make distcheck-fast".
>+So we've put it into its own separate target.
I would skip this occurrence or talke about "the `make distcheck*`
targets".
With the above:
Reviewed-by: Matthias Maennich <maennich@google.com>
Cheers,
Matthias
>
> So, to be complete the regression checking command to run against your
>-patch should be: "make check-self-compare distcheck -j16", if you have
>+patch should be: "make check-self-compare distcheck-fast -j16", if you have
> a machine with a 16 threads processors, for instance.
>
> Coding language and style
>--
>2.25.1
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] Better highlight 'make distcheck-fast'
2021-12-09 12:13 ` Matthias Maennich
@ 2021-12-09 21:38 ` Thomas Schwinge
2021-12-13 16:34 ` Dodji Seketeli
0 siblings, 1 reply; 6+ messages in thread
From: Thomas Schwinge @ 2021-12-09 21:38 UTC (permalink / raw)
To: libabigail; +Cc: Thomas Schwinge, Matthias Maennich
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 3284 bytes --]
... for the reasons stated.
* CONTRIBUTING: Better highlight 'make distcheck-fast'.
Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
Reviewed-by: Matthias Maennich <maennich@google.com>
---
Hi!
Thanks, Matthias, for your prompt review and suggestions, which I've
incorporated. (I decided to "defuse" the "takes twice as much time"
comment altogether, hope that's OK.)
My permissions on sourceware.org are not set up for pushing:
[...]
error: remote unpack failed: unable to create temporary object directory
To ssh://sourceware.org/git/libabigail.git
! [remote rejected] HEAD -> master (unpacker error)
error: failed to push some refs to 'ssh://sourceware.org/git/libabigail.git'
..., so will someone please push this for me?
Grüße
Thomas
---
CONTRIBUTING | 21 ++++++++++++---------
1 file changed, 12 insertions(+), 9 deletions(-)
diff --git CONTRIBUTING CONTRIBUTING
index 7e3e8561..3a2073b3 100644
--- CONTRIBUTING
+++ CONTRIBUTING
@@ -63,25 +63,28 @@ is important, because that is how we do to actually release the
tarball of the project that you can download from the internet) then
you can do:
- make distcheck
+ make distcheck-fast
This actually builds the tarball, then untars it, configure/compile
the untarred source code and launches the regression checks from
there.
+Here, "make distcheck-fast" is a variant of the standard "make distcheck".
+It compresses with "--fast" instead of default "--best", and is
+significantly faster, given the size of the distribution. You very likely
+want to use that one for local regression testing. (However, don't use
+"make distcheck-fast" to create artifacts for distribution.)
+
You can also launch this in parallel by doing:
- make -jN -lN distcheck
+ make -jN -lN distcheck-fast
with N being the number of processor core you have on your system.
-Please make sure you always launch "make distcheck" before sending a
+Please make sure you always launch "make distcheck-fast" before sending a
patch, so that you are sure that we can always build a tarball after
your patch is applied to the source tree.
-A variant of distcheck is "make distcheck-fast". It's like "make
-distcheck" but it's faster. You can just use that one.
-
A complementary regression checking target is "check-self-compare".
You invoke it by doing "make check-self-compare". That target
analyzes the ABI of the libabigail.so shared object, serializes it
@@ -89,11 +92,11 @@ into the ABIXML format and then compares the ABI internal
representation gathered from the libabigail.so binary against the one
gathered from the ABIXML format. The two should be equal if
everything goes right. This is an important regression test. The
-problem is that it can takes twice as much time as make distcheck. So
-we've put it into its own separate target.
+problem is that it can take a considerable amount of time.
+So we've put it into its own separate target.
So, to be complete the regression checking command to run against your
-patch should be: "make check-self-compare distcheck -j16", if you have
+patch should be: "make check-self-compare distcheck-fast -j16", if you have
a machine with a 16 threads processors, for instance.
Coding language and style
--
2.25.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Better highlight 'make distcheck-fast'
2021-12-09 21:38 ` Thomas Schwinge
@ 2021-12-13 16:34 ` Dodji Seketeli
2021-12-14 16:44 ` [PATCH] Further update " Thomas Schwinge
0 siblings, 1 reply; 6+ messages in thread
From: Dodji Seketeli @ 2021-12-13 16:34 UTC (permalink / raw)
To: Thomas Schwinge; +Cc: libabigail, Matthias Maennich
Hello Thomas,
Thomas Schwinge <thomas@codesourcery.com> a écrit:
> ... for the reasons stated.
>
> * CONTRIBUTING: Better highlight 'make distcheck-fast'.
>
> Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
> Reviewed-by: Matthias Maennich <maennich@google.com>
Applied to master! Thanks!
Cheers,
--
Dodji
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH] Further update 'make distcheck-fast'
2021-12-13 16:34 ` Dodji Seketeli
@ 2021-12-14 16:44 ` Thomas Schwinge
2021-12-17 19:23 ` Dodji Seketeli
0 siblings, 1 reply; 6+ messages in thread
From: Thomas Schwinge @ 2021-12-14 16:44 UTC (permalink / raw)
To: libabigail, Dodji Seketeli; +Cc: Thomas Schwinge, Matthias Maennich
What got pushed in recent commit 497357cfd5793e5364a92080d9fae40cf94dc7dd
"Better highlight 'make distcheck-fast'" was the initial submission, before the
changes I made after Matthias Maennich's review. So here they are again.
* CONTRIBUTING: Further update 'make distcheck-fast'.
Suggested-by: Matthias Maennich <maennich@google.com>
Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
---
CONTRIBUTING | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/CONTRIBUTING b/CONTRIBUTING
index f7cef0a8..24a483b2 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -72,7 +72,8 @@ there.
Here, "make distcheck-fast" is a variant of the standard "make distcheck".
It compresses with "--fast" instead of default "--best", and is
significantly faster, given the size of the distribution. You very likely
-want to use that one for local regression testing.
+want to use that one for local regression testing. (However, don't use
+"make distcheck-fast" to create artifacts for distribution.)
You can also launch this in parallel by doing:
@@ -91,7 +92,7 @@ into the ABIXML format and then compares the ABI internal
representation gathered from the libabigail.so binary against the one
gathered from the ABIXML format. The two should be equal if
everything goes right. This is an important regression test. The
-problem is that it can takes twice as much time as "make distcheck-fast".
+problem is that it can take a considerable amount of time.
So we've put it into its own separate target.
So, to be complete the regression checking command to run against your
--
2.25.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] Further update 'make distcheck-fast'
2021-12-14 16:44 ` [PATCH] Further update " Thomas Schwinge
@ 2021-12-17 19:23 ` Dodji Seketeli
0 siblings, 0 replies; 6+ messages in thread
From: Dodji Seketeli @ 2021-12-17 19:23 UTC (permalink / raw)
To: Thomas Schwinge; +Cc: libabigail, Matthias Maennich
Thomas Schwinge <thomas@codesourcery.com> a écrit:
> What got pushed in recent commit 497357cfd5793e5364a92080d9fae40cf94dc7dd
> "Better highlight 'make distcheck-fast'" was the initial submission, before the
> changes I made after Matthias Maennich's review. So here they are again.
>
> * CONTRIBUTING: Further update 'make distcheck-fast'.
>
> Suggested-by: Matthias Maennich <maennich@google.com>
> Signed-off-by: Thomas Schwinge <thomas@codesourcery.com>
Applied to master.
[...]
Cheers,
--
Dodji
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-12-17 19:23 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-09 12:07 [PATCH] Better highlight 'make distcheck-fast' Thomas Schwinge
2021-12-09 12:13 ` Matthias Maennich
2021-12-09 21:38 ` Thomas Schwinge
2021-12-13 16:34 ` Dodji Seketeli
2021-12-14 16:44 ` [PATCH] Further update " Thomas Schwinge
2021-12-17 19:23 ` Dodji Seketeli
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).