aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrey Ponomarenko <andrewponomarenko@yandex.ru>2016-10-09 02:08:52 +0300
committerAndrey Ponomarenko <andrewponomarenko@yandex.ru>2016-10-09 02:08:52 +0300
commit6763a7cac6afd22655ed31cec3b4db3b0ca934d9 (patch)
tree7d420fa6910f2caa3a489eb417111be20a9dac93
parente30363a7a73465ea6192938e82f61257a850c78d (diff)
downloadabi-compliance-checker-6763a7cac6afd22655ed31cec3b4db3b0ca934d9.tar.gz
Note about the test suite.
-rw-r--r--README10
-rw-r--r--doc/index.html13
2 files changed, 22 insertions, 1 deletions
diff --git a/README b/README
index 7345b3a..eeaa460 100644
--- a/README
+++ b/README
@@ -6,6 +6,8 @@ NAME:
The tool is intended for developers of software libraries and Linux maintainers who are interested in ensuring backward compatibility, i.e. allow old applications to run or to be recompiled with newer library versions.
The tool is developed by Andrey Ponomarenko. You can order additional reports for visualization of the ABI structure and high detailed binary compatibility analysis here: https://abi-laboratory.pro/
+
+ The tool is a core of the ABI Tracker and Upstream Tracker projects: https://abi-laboratory.pro/tracker/
INSTALL:
sudo make install prefix=/usr
@@ -54,3 +56,11 @@ USAGE (ORIGINAL):
ADV. USAGE:
For advanced usage, see doc/index.html or output of -help option.
+
+TEST SUITE:
+ The tool is tested properly in the ABI Tracker and Upstream Tracker
+ projects, by the community and by the internal test suite:
+
+ abi-compliance-checker -test
+
+ There are about 100 basic tests for C and about 200 basic tests for C++ API/ABI breaks.
diff --git a/doc/index.html b/doc/index.html
index 6375bee..b04d950 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -62,7 +62,10 @@
<p/>
The tool is developed by Andrey Ponomarenko. You can order additional reports for visualization of the ABI structure and high detailed binary compatibility analysis here: <a href='https://abi-laboratory.pro/'>https://abi-laboratory.pro/</a>
-
+
+ <p/>
+ The tool is a core of the <a href='https://abi-laboratory.pro/tracker/'>ABI Tracker</a> and Upstream Tracker projects.
+
<table class='summary'><tr><td>
<div>Table of Contents</div>
<ul>
@@ -77,6 +80,7 @@
<li><a href="#Examples">Examples</a></li>
<li><a href="#BinaryProblems">Detectable Binary-Compatibility Problems</a></li>
<li><a href="#SourceProblems">Detectable Source-Compatibility Problems</a></li>
+<li><a href="#TestSuite">Test Suite</a></li>
<li><a href="#Dump">Create ABI Dumps</a></li>
<li><a href="#Report">Report Format</a></li>
<li><a href="#Verdict">Verdict on Compatibility</a></li>
@@ -431,6 +435,13 @@ See <a href='https://community.kde.org/Policies/Binary_Compatibility_Issues_With
</ul>
+<a name="TestSuite"></a>
+<h2>Test Suite</h2>
+The tool is tested properly in the <a href='https://abi-laboratory.pro/tracker/'>ABI Tracker</a> and Upstream Tracker projects, by the community and by the internal test suite:
+<p/>
+<code class='code'>abi-compliance-checker -test</code>
+<p/>
+There are about 100 basic tests for C and about 200 basic tests for C++ API/ABI breaks.
<a name="Dump"></a>
<h2>Create ABI Dumps</h2>
The library ABI is a representation of the library API at the binary level. The ABI dump is a dump of the model of the ABI used in the tool.