summaryrefslogtreecommitdiffstats
path: root/ipc/chromium/src/third_party/libevent/extra/abi-check/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /ipc/chromium/src/third_party/libevent/extra/abi-check/README.md
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ipc/chromium/src/third_party/libevent/extra/abi-check/README.md')
-rw-r--r--ipc/chromium/src/third_party/libevent/extra/abi-check/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/ipc/chromium/src/third_party/libevent/extra/abi-check/README.md b/ipc/chromium/src/third_party/libevent/extra/abi-check/README.md
new file mode 100644
index 0000000000..77fdd94128
--- /dev/null
+++ b/ipc/chromium/src/third_party/libevent/extra/abi-check/README.md
@@ -0,0 +1,35 @@
+## libevent ABI/API changes
+
+
+This script is used to generate information about changes in libevent ABI/API
+between various versions using [LVC tools](https://github.com/lvc). Such an
+overview can help developers migrate from one version to another.
+
+Here is the `abi_check.sh`, which is used to generate ABI/API timeline for
+libevent.
+
+You can limit the number of included libevent versions via a number given
+as a parameter to the script. For example
+
+```shell
+$ ./abi_check.sh 3
+```
+
+generates overview for the last 3 versions and the current version.
+If no parameter given, it will generate overview for the last 2 versions and
+the current version by default.
+
+But this script requires some tools that are available in the following docker image:
+
+```
+docker.pkg.github.com/azat/docker-images/lvc-debian
+```
+
+And the full command looks like:
+
+```shell
+ docker run --rm -it -v $PWD:/src:ro -w /src -v tmp/le-abi-check-root:/abi-root -e ABI_CHECK_ROOT=/abi-root docker.pkg.github.com/azat/docker-images/lvc-debian /src/extra/abi-check/abi_check.sh
+```
+
+'timeline/libevent/index.html' is the final result and can be viewed
+[here](https://libevent.org/abi)