summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Espinosa <esodan@gmail.com>2018-01-16 12:26:08 -0600
committerRico Tzschichholz <ricotz@ubuntu.com>2018-01-20 17:34:36 +0100
commit82bd593a41a41cebf4cfb77bf38120e1505a5184 (patch)
treeb6609c3305d5ddb0f3f71eb56e3a5fdc8f17acc8 /doc
parent2ae0ebc8aa27ea4bf0a264432e7a64c8f9fe258b (diff)
downloadvala-82bd593a41a41cebf4cfb77bf38120e1505a5184.tar.gz
compiler: Add --abi-stability option for future ABI stability enablement
https://bugzilla.gnome.org/show_bug.cgi?id=789069
Diffstat (limited to 'doc')
-rw-r--r--doc/valac.111
-rw-r--r--doc/valac.h2m10
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/valac.1 b/doc/valac.1
index 9d0fbad77..7e77a4002 100644
--- a/doc/valac.1
+++ b/doc/valac.1
@@ -199,6 +199,17 @@ Do not write vala build version in generated files
.TP
\fB\-\-run\-args\fR
Arguments passed to directly compiled executeable
+.TP
+\fB\-\-abi\-stability\fR
+Enable support for ABI stability
+.RS
+This changes the current behaviour to output public members of classes and
+interfaces the same order as they appear in Vala source.
+For libraries is recommended to use \fB--abi-stability\fR to ensure the
+maintainability of the resulting Application Binary Interface (ABI).
+This option is disabled by default for backward compatibility because it can
+break ABI of existing projects.
+.RE
.SH BUGS
https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala
.SH "HOMEPAGE OR CONTACT"
diff --git a/doc/valac.h2m b/doc/valac.h2m
index 87b41b7d2..15f66c2af 100644
--- a/doc/valac.h2m
+++ b/doc/valac.h2m
@@ -23,6 +23,16 @@ or \fB--no-color\fR are declared then \fB--color\fR=\fIauto\fR is used where
output is colored when stderr is a terminal.
.RE
+/Enable support for ABI stability/
+.RS
+This changes the current behaviour to output public members of classes and
+interfaces the same order as they appear in Vala source.
+For libraries is recommended to use \fB--abi-stability\fR to ensure the
+maintainability of the resulting Application Binary Interface (ABI).
+This option is disabled by default for backward compatibility because it can
+break ABI of existing projects.
+.RE
+
[BUGS]
https://bugzilla.gnome.org/page.cgi?id=browse.html&product=vala