From patchwork Thu Dec 3 13:24:37 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dodji Seketeli X-Patchwork-Id: 41283 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 C7FC33858023; Thu, 3 Dec 2020 13:24:46 +0000 (GMT) DKIM-Filter: OpenDKIM Filter v2.11.0 sourceware.org C7FC33858023 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sourceware.org; s=default; t=1607001886; bh=ZSS18pjT/AVv12dud3RrbhwtdFX9ixeysZcRgkRB9g8=; h=To:Subject:Date:List-Id:List-Unsubscribe:List-Archive:List-Help: List-Subscribe:From:Reply-To:From; b=EmdyiwfZ1yhlAHO2Mgyne39RaLUQkd2SZyZJXZaU352dDaw0YYzCc7GUheG30/lMd XqHqDqT+1lGWDo4lSKSZdzTrwi9KxwJe45Vowd8Tl7DrqXCkAIB/v2eQ82v7ryEv7u N9rBQDHMHMNdPXdWUZsw2S8C2b/XDrD/odd1JHyo= X-Original-To: libabigail@sourceware.org Delivered-To: libabigail@sourceware.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [63.128.21.124]) by sourceware.org (Postfix) with ESMTP id 9D47E3858023 for ; Thu, 3 Dec 2020 13:24:44 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.3.2 sourceware.org 9D47E3858023 Received: from mail-wm1-f72.google.com (mail-wm1-f72.google.com [209.85.128.72]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-262-L_BWQwAoNTihEQZ-lB9Ixg-1; Thu, 03 Dec 2020 08:24:42 -0500 X-MC-Unique: L_BWQwAoNTihEQZ-lB9Ixg-1 Received: by mail-wm1-f72.google.com with SMTP id k128so1455038wme.7 for ; Thu, 03 Dec 2020 05:24:42 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:organization:date:message-id :user-agent:mime-version; bh=ZSS18pjT/AVv12dud3RrbhwtdFX9ixeysZcRgkRB9g8=; b=PIofheibuTq9FpqsGpQHhGphcddv25Kkt6laEd204X/YS6bE39ci8bdRLzuLIo4ckx yBXV2UeWmN6ytt+MSxUT5X/Ljongvw/82W4+NZg6Sycb6YCyiDA380q4g8tdm+dx8V6n ueuT/OsuWRXgbWa8LHuJFb3yQyhc70PMjlkYb/F5wpDe9cDoKDugCw1Tw+iZraiHY9HR WYIvUEFFwD3uRJGcUVaCWWQuRtDDZMGHzG5J1FcbObZpX4ncecgclj97UL1RPMCySOzf B5oIFTiYbEQdbukRijem101TSn3jvWjUtt+fodWASwxbRw57zTalJ5R0tiTLEIc8L7Jj 6qOA== X-Gm-Message-State: AOAM530cPVKqr/5VFuCGKZBVxX59UJy6WRRflsFvekSktfumzpmi3eQl 3O0p2kei4HhA06KXIg/xxZh4Pvi3x4VkgXi9UMT6m09vV7aXdr6UPHS+LJw7KfyMCFU1C7llRci quiMny5587QPS/9httYty/L59yBDcWY78Jr8mkDgAmInmPIEv9JnsKzrpNslI2l1ppKls X-Received: by 2002:a05:600c:410d:: with SMTP id j13mr3351472wmi.95.1607001880802; Thu, 03 Dec 2020 05:24:40 -0800 (PST) X-Google-Smtp-Source: ABdhPJxAYoyWb2am3k28meyEx25H45imaPARVG91ycqqHBDC1aIp5KGMZdkxkWkjd6WJJ4/Z0JstVQ== X-Received: by 2002:a05:600c:410d:: with SMTP id j13mr3351440wmi.95.1607001880447; Thu, 03 Dec 2020 05:24:40 -0800 (PST) Received: from localhost (91-166-131-65.subs.proxad.net. [91.166.131.65]) by smtp.gmail.com with ESMTPSA id t136sm1616461wmt.18.2020.12.03.05.24.39 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Thu, 03 Dec 2020 05:24:39 -0800 (PST) Received: by localhost (Postfix, from userid 1001) id DC5591A2630; Thu, 3 Dec 2020 14:24:37 +0100 (CET) To: libabigail@sourceware.org Subject: [PATCH] CONTRIBUTING: Update instructions about regression tests Organization: Red Hat / France X-Operating-System: Red Hat Enterprise Linux Server 7.8 X-URL: http://www.redhat.com Date: Thu, 03 Dec 2020 14:24:37 +0100 Message-ID: <86k0tzowdm.fsf@redhat.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.3 (gnu/linux) MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-11.6 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, SPF_HELO_NONE, SPF_PASS, TXREP autolearn=ham autolearn_force=no version=3.4.2 X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) 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: , X-Patchwork-Original-From: Dodji Seketeli via Libabigail From: Dodji Seketeli Reply-To: Dodji Seketeli Errors-To: libabigail-bounces@sourceware.org Sender: "Libabigail" Hello, I thought I'd update the contribution instructions about how to run the regression tests as the "check-self-compare" target appeared recently. * CONTRIBUTING: Update instructions about how to launch regression tests. Signed-off-by: Dodji Seketeli Applied to master. --- CONTRIBUTING | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 0b0f904..b1f58df 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -38,7 +38,7 @@ visibility of symbols that are part of the API and ABI of libabigail. Make sure you sign your patch. To learn about signing, please read the "Sign your work" chapter below. -One important thing to be before sending your patch is to launch the +One important thing to do before sending your patch is to launch the regression tests. Regression tests @@ -79,6 +79,23 @@ Please make sure you always launch "make distcheck" 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 +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. + +So, to be complete the regression checking command to run against your +patch should be: "make check-self-compare distcheck -j16", if you have +a machine with a 16 threads processors, for instance. + Launching regression tests in Valgrind --------------------------------------