summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRandy MacLeod <Randy.MacLeod@windriver.com>2022-02-08 14:32:56 -0500
committerDodji Seketeli <dodji@redhat.com>2022-02-25 11:24:20 +0100
commit4aa7f3833470b223a4ea43e26f8135bea051d78c (patch)
tree08c6881e4d96acaeb96bac244e9c4cfbd04caf16
parentXML writer: do not create extra temporary referenced type shared_ptr (diff)
downloadlibabigail-4aa7f3833470b223a4ea43e26f8135bea051d78c.tar.gz
libabigail-4aa7f3833470b223a4ea43e26f8135bea051d78c.tar.bz2
libabigail-4aa7f3833470b223a4ea43e26f8135bea051d78c.tar.xz
Improve some grammar
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>
-rw-r--r--COMPILING10
-rw-r--r--CONTRIBUTING8
-rw-r--r--README2
-rw-r--r--VISIBILITY3
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:
13 pkg-config 13 pkg-config
14 14
15If you want to build the documentation of libabigail, then you also 15If you want to build the documentation of libabigail, then you also
16need these packages (and its dependencies): 16need these packages (and their dependencies):
17 17
18 doxygen 18 doxygen
19 python-sphinx 19 python-sphinx
20 20
21Note that if you are installing these packages in a binary form 21Note that if you are installing these packages in a binary form
22provided by your distribution, then you probably need to install the 22provided by your distribution, then you probably need to install the
23development variant of those that have one. 23development variant of those packages if the distribution has one.
24 24
25Once you have installed the development packages of the dependencies, 25Once you have installed the development packages of the dependencies,
26there are two options for compiling libabigail, depending on the two 26there are two options for compiling libabigail, depending on the two
27kinds of source code package you have: either you've got the source 27kinds of source code packages you have: either you have the source
28code from our Git source control management system, or you've got a 28code from our Git source control management system, or you have a
29released tarball. 29released tarball.
30 30
31* Getting and compiling libabigail from Git 31* Getting and compiling libabigail from Git
@@ -99,7 +99,7 @@ Once you've done that, type:
99 make doc 99 make doc
100 100
101This will generate the documentation in html, info and man format, in 101This will generate the documentation in html, info and man format, in
102under the doc/ subdirectory of your build directory. 102the doc/ subdirectory of your build directory.
103 103
104If you only want the html documentation (mainly the web site, apidoc and manuals) then just type: 104If you only want the html documentation (mainly the web site, apidoc and manuals) then just type:
105 105
diff --git a/CONTRIBUTING b/CONTRIBUTING
index 5ab7bcce..cbdc9843 100644
--- a/CONTRIBUTING
+++ b/CONTRIBUTING
@@ -110,7 +110,7 @@ To do so, please do:
110 110
111 make check-valgrind 111 make check-valgrind
112 112
113This runs the tests under the control of Valgrind memcheck and 113This runs the tests under the control of the Valgrind memcheck and
114helgrind tools. 114helgrind tools.
115 115
116But then, if you want Valgrind to check the libabigail command line 116But 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
135binaries to compare. Once the comparison is done, the resulting 135binaries to compare. Once the comparison is done, the resulting
136report is compared against a reference report that is provided. 136report is compared against a reference report that is provided.
137 137
138Test executable have names that starts with 'runtest*'. For instance, 138Test executables have names that starts with 'runtest*'. For instance,
139under <build-directory>/tests/ you can find tests named 139under <build-directory>/tests/ you can find tests named
140runtestdiffdwarf, runtestabidiff, etc... 140runtestdiffdwarf, runtestabidiff, etc...
141 141
@@ -151,8 +151,8 @@ runtestdiffdwarf is to be found under tests/data/test-diff-dwarf.
151Data for the test runtestabidiff is to be found under 151Data for the test runtestabidiff is to be found under
152tests/data/test-abidiff.cc. 152tests/data/test-abidiff.cc.
153 153
154So adding your own tests usually just amounts to adding the input 154So adding your own tests usually just amounts to adding the right input
155right input into the right sub-directory of tests/data/. To do so, 155into the right sub-directory of tests/data/. To do so,
156look at several tests/test-*.cc to see which one you'd like to add 156look at several tests/test-*.cc to see which one you'd like to add
157some input binaries to be compared in. 157some input binaries to be compared in.
158 158
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
5ABI-relevant artifacts. 5ABI-relevant artifacts.
6 6
7The set of artifacts that we are intersted is made of quantities like 7The set of artifacts that we are intersted is made of quantities like
8types, variable, fonctions and declarations of a given library or 8types, variable, functions and declarations of a given library or
9program. For a given library or program this set of quantities is 9program. For a given library or program this set of quantities is
10called an ABI corpus. 10called an ABI corpus.
11 11
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
5========================================================== 5==========================================================
6 6
7We try to limit the number of ELF symbols that are exported by the 7We try to limit the number of ELF symbols that are exported by the
8libabigail.so shared library. We call this symbols visibility 8libabigail.so shared library. We call this, "symbol visibility control".
9control.
10 9
11As GNU/Linux is our development platform, we control symbol visibility 10As GNU/Linux is our development platform, we control symbol visibility
12by using the visibility support of the G++ compiler. 11by using the visibility support of the G++ compiler.