xamarin-macios/tools/apidiff
Sebastien Pouliot fcd270cc37 [apidiff] Update references definition to C7 stable (XI 9.8 / XM 2.8) (#142)
Newer apidiff from master will compare to C7 (instead of C6)
2016-06-07 17:04:37 -04:00
..
references [apidiff] Update references definition to C7 stable (XI 9.8 / XM 2.8) (#142) 2016-06-07 17:04:37 -04:00
.gitignore Add apidiff tool. 2016-04-24 14:47:29 -04:00
Makefile [jenkins] Run the api diff. (#73) 2016-06-02 14:30:17 +02:00
README.md [tools/apidiff] Fix typo in README. 2016-04-24 15:59:43 -04:00

README.md

= New Releases =

Doing a make update-refs will update the XML files where we keep the current public API.

The result should be added/committed to git so every future revisions can be compared to the reference files.

= Update reference sources using the dlls from the System version of XI/XM =

make update-ios-refs     -j IOS_DESTDIR= IOS_INSTALL_VERSION=Current
make update-watchos-refs -j IOS_DESTDIR= IOS_INSTALL_VERSION=Current
make update-tvos-refs    -j IOS_DESTDIR= IOS_INSTALL_VERSION=Current
make update-mac-refs     -j MAC_DESTDIR= MAC_INSTALL_VERSION=Current

You can change *_INSTALL_VERSION to other than Current if you have a different version installed (say you have XI 9.4.0.0 installed in /Library/Frameworks/Xamarin.iOS.framework/Versions/9.4.0.0, in which case you can do IOS_INSTALL_VERSION=9.4.0.0

= New Revisions =

On the bots each revision rebuilds every assemblies. Each of them will be compared to the XML reference files. Any changes (addition/removal) to the public API will be reported in HTML files.

This can be done manually with make. The .\diff\ directory will contain the diffs in HTML format.

The helper make merge target creates a single api-diff.html file (from all the diff\*.html files) that be used for the documentation web site.