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