From patchwork Thu Dec 9 21:38:34 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Thomas Schwinge X-Patchwork-Id: 48729 Return-Path: X-Original-To: patchwork@sourceware.org Delivered-To: patchwork@sourceware.org Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id D288A3858016 for ; Thu, 9 Dec 2021 21:53:15 +0000 (GMT) X-Original-To: libabigail@sourceware.org Delivered-To: libabigail@sourceware.org Received: from smtprelay02.ispgateway.de (smtprelay02.ispgateway.de [80.67.18.14]) by sourceware.org (Postfix) with ESMTPS id 897DB3858C27 for ; Thu, 9 Dec 2021 21:53:11 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 897DB3858C27 Authentication-Results: sourceware.org; dmarc=none (p=none dis=none) header.from=codesourcery.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=schwinge.name Received: from [192.94.31.2] (helo=dem-tschwing-1.ger.mentorg.com) by smtprelay02.ispgateway.de with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.94.2) (envelope-from ) id 1mvRLb-0003mz-N8; Thu, 09 Dec 2021 22:53:03 +0100 Received: (nullmailer pid 3046885 invoked by uid 1000); Thu, 09 Dec 2021 21:53:08 -0000 From: Thomas Schwinge To: libabigail@sourceware.org Subject: [PATCH] Better highlight 'make distcheck-fast' Date: Thu, 9 Dec 2021 22:38:34 +0100 Message-Id: <20211209213833.3045196-1-thomas@codesourcery.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: References: MIME-Version: 1.0 X-Df-Sender: b3V0Z29pbmdAc2Nod2luZ2UubmFtZQ== X-Spam-Status: No, score=-10.9 required=5.0 tests=BAYES_00, GIT_PATCH_0, HEADER_FROM_DIFFERENT_DOMAINS, KAM_DMARC_STATUS, PP_MIME_FAKE_ASCII_TEXT, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, SPF_HELO_PASS, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.4 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on server2.sourceware.org X-BeenThere: libabigail@sourceware.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Mailing list of the Libabigail project List-Unsubscribe: , List-Archive: List-Help: List-Subscribe: , Cc: Matthias Maennich , Thomas Schwinge Errors-To: libabigail-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libabigail" ... for the reasons stated. * CONTRIBUTING: Better highlight 'make distcheck-fast'. Signed-off-by: Thomas Schwinge Reviewed-by: Matthias Maennich --- 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