diff options
| author | Richard W.M. Jones <rjones@redhat.com> | 2012-07-11 10:47:18 +0100 |
|---|---|---|
| committer | Richard W.M. Jones <rjones@redhat.com> | 2012-07-11 10:47:18 +0100 |
| commit | 196742cd46a8d80f0298f9f58c540482919306a3 (patch) | |
| tree | 5cb7af9d8b22fa3e549ebeb3e5d8536690b7c542 /generator/README | |
| parent | cf0defedb8121a0ff39c1d4c6d9f3eee9fd7ee72 (diff) | |
| download | libguestfs-196742cd46a8d80f0298f9f58c540482919306a3.tar.gz libguestfs-196742cd46a8d80f0298f9f58c540482919306a3.tar.xz libguestfs-196742cd46a8d80f0298f9f58c540482919306a3.zip | |
generator: Add a note in generator/README about safely extending functions.
Diffstat (limited to 'generator/README')
| -rw-r--r-- | generator/README | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/generator/README b/generator/README index de146555..f7dde116 100644 --- a/generator/README +++ b/generator/README @@ -39,3 +39,12 @@ When referring to another action, use the format C<guestfs_other> (ie. the full name of the C function). This will be replaced as appropriate in other language bindings. Apart from that, long descriptions are just perldoc paragraphs. + +Note about extending functions: + +In general you cannot change the name, number of required arguments or +type of required arguments of a function, since this would break +backwards compatibility. + +You may add another optional argument, *if* the function has >= 1 +optional arguments already. Add it at the end of the list. |