From patchwork Tue Feb 8 19:32:56 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Randy MacLeod X-Patchwork-Id: 50923 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 3BA583857817 for ; Tue, 8 Feb 2022 19:33:19 +0000 (GMT) X-Original-To: libabigail@sourceware.org Delivered-To: libabigail@sourceware.org Received: from mail1.wrs.com (unknown-3-146.windriver.com [147.11.3.146]) by sourceware.org (Postfix) with ESMTPS id 1077A385801F for ; Tue, 8 Feb 2022 19:33:04 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.1 sourceware.org 1077A385801F Authentication-Results: sourceware.org; dmarc=fail (p=none dis=none) header.from=windriver.com Authentication-Results: sourceware.org; spf=fail smtp.mailfrom=windriver.com Received: from mail.windriver.com (mail.wrs.com [147.11.1.11]) by mail1.wrs.com (8.15.2/8.15.2) with ESMTPS id 218JWwUh003848 (version=TLSv1.1 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL) for ; Tue, 8 Feb 2022 11:32:59 -0800 Received: from ala-exchng01.corp.ad.wrs.com (ala-exchng01.corp.ad.wrs.com [147.11.82.252]) by mail.windriver.com (8.15.2/8.15.2) with ESMTPS id 218JWwbR014293 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=FAIL) for ; Tue, 8 Feb 2022 11:32:58 -0800 (PST) Received: from ALA-EXCHNG02.corp.ad.wrs.com (147.11.82.254) by ala-exchng01.corp.ad.wrs.com (147.11.82.252) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2242.12; Tue, 8 Feb 2022 11:32:57 -0800 Received: from ala-exchng01.corp.ad.wrs.com (147.11.82.252) by ALA-EXCHNG02.corp.ad.wrs.com (147.11.82.254) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2308.21; Tue, 8 Feb 2022 11:32:57 -0800 Received: from vme.wrs.com (172.25.44.7) by ala-exchng01.corp.ad.wrs.com (147.11.82.252) with Microsoft SMTP Server id 15.1.2242.12 via Frontend Transport; Tue, 8 Feb 2022 11:32:57 -0800 From: Randy MacLeod To: Subject: [PATCH] Improve some grammar Date: Tue, 8 Feb 2022 14:32:56 -0500 Message-ID: <20220208193256.131276-1-Randy.MacLeod@windriver.com> X-Mailer: git-send-email 2.32.0 MIME-Version: 1.0 X-Spam-Status: No, score=-13.5 required=5.0 tests=BAYES_00, GIT_PATCH_0, KAM_DMARC_NONE, KAM_DMARC_STATUS, KHOP_HELO_FCRDNS, SPF_FAIL, SPF_HELO_NONE, T_SCC_BODY_TEXT_LINE 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: , Errors-To: libabigail-bounces+patchwork=sourceware.org@sourceware.org Sender: "Libabigail" Fix typos and try to improve some grammar in the files in the top level directory. * COMPILING: Improve grammar * CONTRIBUTING: Improve grammar * README: Improve grammar * VISIBILITY: Improve grammar Signed-off-by: Randy MacLeod --- COMPILING | 10 +++++----- CONTRIBUTING | 8 ++++---- README | 2 +- VISIBILITY | 3 +-- 4 files changed, 11 insertions(+), 12 deletions(-) diff --git a/COMPILING b/COMPILING index 33613a37..1d9932c1 100644 --- a/COMPILING +++ b/COMPILING @@ -13,19 +13,19 @@ following packages: pkg-config If you want to build the documentation of libabigail, then you also -need these packages (and its dependencies): +need these packages (and their dependencies): doxygen python-sphinx Note that if you are installing these packages in a binary form provided by your distribution, then you probably need to install the -development variant of those that have one. +development variant of those packages if the distribution has one. Once you have installed the development packages of the dependencies, there are two options for compiling libabigail, depending on the two -kinds of source code package you have: either you've got the source -code from our Git source control management system, or you've got a +kinds of source code packages you have: either you have the source +code from our Git source control management system, or you have a released tarball. * Getting and compiling libabigail from Git @@ -99,7 +99,7 @@ Once you've done that, type: make doc This will generate the documentation in html, info and man format, in -under the doc/ subdirectory of your build directory. +the doc/ subdirectory of your build directory. If you only want the html documentation (mainly the web site, apidoc and manuals) then just type: diff --git a/CONTRIBUTING b/CONTRIBUTING index 5ab7bcce..cbdc9843 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -110,7 +110,7 @@ To do so, please do: make check-valgrind -This runs the tests under the control of Valgrind memcheck and +This runs the tests under the control of the Valgrind memcheck and helgrind tools. But then, if you want Valgrind to check the libabigail command line @@ -135,7 +135,7 @@ Generally, both are usually made of a loop that churns through a set of input binaries to compare. Once the comparison is done, the resulting report is compared against a reference report that is provided. -Test executable have names that starts with 'runtest*'. For instance, +Test executables have names that starts with 'runtest*'. For instance, under /tests/ you can find tests named runtestdiffdwarf, runtestabidiff, etc... @@ -151,8 +151,8 @@ runtestdiffdwarf is to be found under tests/data/test-diff-dwarf. Data for the test runtestabidiff is to be found under tests/data/test-abidiff.cc. -So adding your own tests usually just amounts to adding the input -right input into the right sub-directory of tests/data/. To do so, +So adding your own tests usually just amounts to adding the right input +into the right sub-directory of tests/data/. To do so, look at several tests/test-*.cc to see which one you'd like to add some input binaries to be compared in. diff --git a/README b/README index 10f8335d..93c2ba7a 100644 --- a/README +++ b/README @@ -5,7 +5,7 @@ It aims at constructing, manipulating, serializing and de-serializing ABI-relevant artifacts. The set of artifacts that we are intersted is made of quantities like -types, variable, fonctions and declarations of a given library or +types, variable, functions and declarations of a given library or program. For a given library or program this set of quantities is called an ABI corpus. diff --git a/VISIBILITY b/VISIBILITY index b78111be..652ff13a 100644 --- a/VISIBILITY +++ b/VISIBILITY @@ -5,8 +5,7 @@ How symbols that are exported are controlled in libabigail ========================================================== We try to limit the number of ELF symbols that are exported by the -libabigail.so shared library. We call this symbols visibility -control. +libabigail.so shared library. We call this, "symbol visibility control". As GNU/Linux is our development platform, we control symbol visibility by using the visibility support of the G++ compiler.