vppapigen: api crc checker 81/26881/16
authorOle Troan <ot@cisco.com>
Tue, 5 May 2020 10:23:47 +0000 (12:23 +0200)
committerAndrew Yourtchenko <ayourtch@gmail.com>
Sat, 9 May 2020 11:35:58 +0000 (11:35 +0000)
commit5c318c70d09a530a7bd89f973e931def0ba191a4
tree27164df95fb1182fe1872873e84d9033b3b776a2
parentaa55a926feca1e281494120de5550cbfb32e9d5f
vppapigen: api crc checker

crcchecker is a tool for enforcement of the binary API.

1. Production APIs should never change.
2. An API can be deprecated across three release cycles.
   Release 1: API is marked as deprecated.
   option deprecated="vyy.mm";
   option replaced_by="new_api_2";
   Release 2: both old and new APIs are supported
   Release 3: the deprecated API is deleted.
3. APIs that are experimental / not released are not checked.
   An API message can be individually marked as in progress, by:
   option status="in_progress";
   In the API definition.

The definition of a "production API" is if the major version in the API file is > 0.

extras/scripts/crcchecker.py --check-patchset # returns -1 if backwards incompatible
extras/scripts/crcchecker.py --dump-manifest
extras/scripts/crcchecker.py --git-revision v20.01 <files>
extras/scripts/crcchecker.py -- diff <oldfile> <newfile>

This patch integrates the tool in "make checkstyle-api".
A future patch is required to integrate the tool in the verify job.
I.e. this patch does not enable enforcement through Jenkins.

Change-Id: I5f13c0976d8a12a58131b3e270f2dc9c00dc7d8c
Type: feature
Signed-off-by: Ole Troan <ot@cisco.com>
Makefile
extras/scripts/crcchecker.py [new file with mode: 0755]
extras/scripts/tests/test_crcchecker.sh [new file with mode: 0755]
src/tools/vppapigen/vppapigen.py
src/tools/vppapigen/vppapigen_crc.py [new file with mode: 0644]