summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2012-09-15 13:27:50 +0100
committerRichard W.M. Jones <rjones@redhat.com>2012-09-15 13:27:50 +0100
commit44a11e955b31f7c0cf463a04d640263cccdd0c4d (patch)
treeed484535eee757839b0798c9c771bc9ca41e35cd
parent6361810b53be4d5e0513b4f7c11d29cf1d6d3b45 (diff)
downloadlibguestfs-44a11e955b31f7c0cf463a04d640263cccdd0c4d.tar.gz
libguestfs-44a11e955b31f7c0cf463a04d640263cccdd0c4d.tar.xz
libguestfs-44a11e955b31f7c0cf463a04d640263cccdd0c4d.zip
generator: Remove inaccurate comment.
The correct way to extend functions is documented in generator/README. This comment was no longer accurate.
-rw-r--r--generator/types.ml20
1 files changed, 0 insertions, 20 deletions
diff --git a/generator/types.ml b/generator/types.ml
index e15e5a1d..a9b94441 100644
--- a/generator/types.ml
+++ b/generator/types.ml
@@ -37,26 +37,6 @@ type style = ret * args * optargs
* $g->fn (required1, required2, opt1 => val, opt2 => val);
* As the name suggests these are optional, and the function can
* tell which optional parameters were supplied by the caller.
- *
- * Only [Bool], [Int], [Int64], [String] may currently appear in
- * the optional argument list (we may permit more types in future).
- *
- * ABI and API considerations
- * --------------------------
- *
- * The return type and required arguments may not be changed after
- * these have been published in a stable version of libguestfs,
- * because doing so would break the ABI.
- *
- * If a published function has one or more optional arguments,
- * then the call can be extended without breaking the ABI or API.
- * This is in fact the only way to change an existing function.
- * There are limitations on this:
- *
- * (1) you may _only_ add extra elements at the end of the list
- * (2) you may _not_ rearrange or rename or remove existing elements
- * (3) you may _not_ add optional arguments to a function which did
- * not have any before (since this breaks the C ABI).
*)
and ret =