ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

audit: Add a README file

Browse source
This commit is contained in:
Bertrand Lorentz 2013-03-29 19:17:54 +01:00
parent 7da6eb1fa4
commit 2b03787ac0
1 changed files with 28 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
audit/README Normal file
View file

@ -0,0 +1,28 @@
The audit/ folder contains various tools that are used to analyze API changes.
This analysis is done by inspecting the assembly binaries, so you need to
compile them first.
The usual workflow is as follows:
1. Generate the API info for the current version of the assemblies
./get-apiinfo.pl .. data/curr
This will find all *.dll files in Gtk#, produce one <assembly-name>.apiinfo
file per DLL, and save them in the data/curr folder
2. Analyze differences between a baseline and the current API info
./get-apidiff.pl base data/curr data/diff
This will generate one <assembly-name>.apidiff file for each *.apiinfo file in
the base folder, and save it in the data/diff folder.
3. Generate an HTML report for the API differences
mono gen-apidiff-html.exe data/diff html/diff.html
This will use the data in data/diff to generate a single HTML file and save it
as html/diff.html. You can then open this file in a browser to review the API
changes.