From 2b03787ac07ae25bc37373ec4cf46a25e4d4cb43 Mon Sep 17 00:00:00 2001 From: Bertrand Lorentz Date: Fri, 29 Mar 2013 19:17:54 +0100 Subject: [PATCH] audit: Add a README file --- audit/README | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 audit/README diff --git a/audit/README b/audit/README new file mode 100644 index 000000000..b19cdcddd --- /dev/null +++ b/audit/README @@ -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 .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 .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.