[acceptance-tests] Add code from xamarin/mono extensions branch

[mono.git] / acceptance-tests / README.md

diff --git a/acceptance-tests/README.md b/acceptance-tests/README.md
new file mode 100644 (file)
index 0000000..d1322fc
--- /dev/null
+++ b/acceptance-tests/README.md
@@ -0,0 +1,14 @@
+This directory contains functionality for handling optional non git submodule based submodules.
+
+The SUBMODULES.json file stores information about the submodules, and make targets are used to check out submodules, check their versions, and update the submodule information.
+
+By convention, submodules repositories are at the same level as the mono repository.
+
+Make targets available:
+
+make check-<module> - Checks whenever <module> is checked out and matches the version in the info file.
+make reset-<module> - Clones <module>if neccesary and checks out the revision specified in the info file.
+make bump-<module> - Updates the revision stored in the info file for <module>.
+make bump-current-<module> - Updates the revision stored in the info file for <module> to the current revision.
+make commit-bump-<module> - Same as make bump-<module>, but commits the change.
+make commit-bump-current-<module> - Same as make bump-current-<module>, but commits the change.