mirror of
https://github.com/warmcat/libwebsockets.git
synced 2025-03-16 00:00:07 +01:00
Script and config to make tracking ABI/API changes easy.
This commit is contained in:
parent
c673125ce0
commit
afda4f6c44
3 changed files with 56 additions and 0 deletions
48
contrib/abi/README.md
Normal file
48
contrib/abi/README.md
Normal file
|
@ -0,0 +1,48 @@
|
|||
ABI Compatility Tracking
|
||||
========================
|
||||
|
||||
This directory contains files that can be used to generate an ABI compatibility
|
||||
timeline for libwebsockets. This gives users an idea of where the library has
|
||||
changed and can be used by the developers to see when incompatible changes have
|
||||
been introduced and either increase the library SO version or fix the changes.
|
||||
|
||||
The tools used are the abi-\* family available at https://github.com/lvc/ and
|
||||
some example output is here: http://abi-laboratory.pro/tracker/timeline/libuv/
|
||||
|
||||
The tools download existing source tarballs and git repository to generate this
|
||||
data, so past versions are compared and in-development code can be compared as
|
||||
well.
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
The author provides an easy way to install the various tools he provides:
|
||||
|
||||
git clone https://github.com/lvc/installer
|
||||
cd installer
|
||||
make prefix=/usr/local abi-tracker
|
||||
|
||||
It will also list any dependencies that you need to install through normal
|
||||
means.
|
||||
|
||||
|
||||
Generating the output
|
||||
---------------------
|
||||
|
||||
Use the `lws-abi-update.sh` script to download the source files, build them and
|
||||
generate the output html. The output can be deployed to a directory on a web
|
||||
server for example. Modify the commented line in lws-abi-update.sh to do this.
|
||||
|
||||
As it is configured, lws-abi-update.sh will only download new source - ones
|
||||
that it hasn't built before - so is suitable for use with a cron job.
|
||||
|
||||
|
||||
Viewing the output
|
||||
------------------
|
||||
|
||||
The best place to start looking at the data is the `timeline/libwebsockets`
|
||||
directory. If your path is on a web server, navigate there, otherwise you could
|
||||
try:
|
||||
|
||||
lynx timeline/libwebsockets/
|
5
contrib/abi/libwebsockets.json
Normal file
5
contrib/abi/libwebsockets.json
Normal file
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"Name": "libwebsockets",
|
||||
"SourceUrl": "https://github.com/warmcat/libwebsockets/releases",
|
||||
"Git": "https://github.com/warmcat/libwebsockets",
|
||||
}
|
3
contrib/abi/lws-abi-update.sh
Executable file
3
contrib/abi/lws-abi-update.sh
Executable file
|
@ -0,0 +1,3 @@
|
|||
abi-monitor -get -build-new libwebsockets.json
|
||||
abi-tracker -build libwebsockets.json
|
||||
#abi-tracker -deploy /path/to/htdocs libwebsockets.json
|
Loading…
Add table
Reference in a new issue