Improve some grammar

Message ID 20220208193256.131276-1-Randy.MacLeod@windriver.com
State New
Headers
Series Improve some grammar |

Commit Message

Randy MacLeod Feb. 8, 2022, 7:32 p.m. UTC
  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 <Randy.MacLeod@windriver.com>
---
 COMPILING    | 10 +++++-----
 CONTRIBUTING |  8 ++++----
 README       |  2 +-
 VISIBILITY   |  3 +--
 4 files changed, 11 insertions(+), 12 deletions(-)
  

Comments

Dodji Seketeli Feb. 25, 2022, 4:22 p.m. UTC | #1
Randy MacLeod <Randy.MacLeod@windriver.com> a écrit:

> 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 <Randy.MacLeod@windriver.com>

Applied to master, thanks!

[...]

Cheers,
  

Patch

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 <build-directory>/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.