GtkSharp/audit
2013-03-29 19:17:54 +01:00
..
base 2008-12-12 Mike Kestner <mkestner@novell.com> 2008-12-12 16:10:15 +00:00
html audit: Add gen-apidiff-html tool to generate apidiff reports 2013-03-29 17:50:07 +01:00
AssemblyResolver.cs audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00
audit.csproj Add an audit.csproj to the MonoDevelop solution 2013-03-29 17:57:34 +01:00
extract-missing.cs add missing attribute formatting 2007-11-07 21:46:10 +00:00
gen-apidiff-html.cs audit: Add gen-apidiff-html tool to generate apidiff reports 2013-03-29 17:50:07 +01:00
get-apidiff.pl 2005-05-21 Mike Kestner <mkestner@novell.com> 2005-05-21 16:41:11 +00:00
get-apiinfo.pl audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00
get-missing.pl 2005-05-21 Mike Kestner <mkestner@novell.com> 2005-05-21 16:41:11 +00:00
makefile audit: Use dmcs as a compiler for the audit tools 2013-03-29 18:18:28 +01:00
mono-api-diff.cs audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00
mono-api-info.cs audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00
mono-api.xsl audit: Add gen-apidiff-html tool to generate apidiff reports 2013-03-29 17:50:07 +01:00
README audit: Add a README file 2013-03-29 19:17:54 +01:00
Util.cs audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00
WellFormedXmlWriter.cs audit: Refresh utilities using code from Mono git master 2013-03-29 17:35:07 +01:00

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.