mirror of
git://sourceware.org/git/libabigail.git
synced 2025-02-09 18:17:07 +00:00
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>
This commit is contained in:
parent
f723989845
commit
4aa7f38334
10
COMPILING
10
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:
|
||||
|
||||
|
@ -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.
|
||||
|
||||
|
2
README
2
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.
|
||||
|
||||
|
@ -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.
|
||||
|
Loading…
Reference in New Issue
Block a user