summaryrefslogtreecommitdiffstats
path: root/asn1/README
diff options
context:
space:
mode:
Diffstat (limited to 'asn1/README')
-rw-r--r--asn1/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/asn1/README b/asn1/README
new file mode 100644
index 000000000..ec9752f56
--- /dev/null
+++ b/asn1/README
@@ -0,0 +1,17 @@
+libipaasn1.a is a small static convenience library used by other ipa
+binaries and modules. At the moment it is not meant to be a public shared
+library and stable interface, but may become one in future.
+
+The only files that should be manually modified are:
+* asn1c/ipa.asn1 - when new interfaces are added
+* ipa_asn1.[ch] - to add wrappers around interfaces
+
+ipa_asn1.[ch] are the public interface and they SHOULD NOT export generated
+structures so that the autogenerated code can change w/o impacting any other
+code except the internal library functions.
+
+To regenerate the automatically generated files run the following command:
+cd asn1c;
+make regenerate
+
+Remember to commit and add any new file to asn1c/Makefile.am