diff mbox series

Better highlight 'make distcheck-fast'

Message ID 20211209213833.3045196-1-thomas@codesourcery.com
State Superseded
Headers show
Series Better highlight 'make distcheck-fast' | expand

Commit Message

Thomas Schwinge Dec. 9, 2021, 9:38 p.m. UTC
... 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(-)

Comments

Dodji Seketeli Dec. 13, 2021, 4:34 p.m. UTC | #1
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,
diff mbox series

Patch

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